mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
test embbeding
This commit is contained in:
54
docs/api/beta/access-profiles.tag.mdx
Normal file
54
docs/api/beta/access-profiles.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
37
docs/api/beta/access-request-approvals.tag.mdx
Normal file
37
docs/api/beta/access-request-approvals.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
24
docs/api/beta/access-request-identity-metrics.tag.mdx
Normal file
24
docs/api/beta/access-request-identity-metrics.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
35
docs/api/beta/access-requests.tag.mdx
Normal file
35
docs/api/beta/access-requests.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
53
docs/api/beta/account-activities.tag.mdx
Normal file
53
docs/api/beta/account-activities.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
30
docs/api/beta/account-aggregations.tag.mdx
Normal file
30
docs/api/beta/account-aggregations.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
23
docs/api/beta/account-usages.tag.mdx
Normal file
23
docs/api/beta/account-usages.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
47
docs/api/beta/accounts.tag.mdx
Normal file
47
docs/api/beta/accounts.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Notification of Ignored Access Request Recommendations</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/ai-access-request-recommendations/ignored-items"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The recommended access item to ignore for an identity.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Recommendation successfully stored as ignored.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"2017-07-11T18:45:37.098Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Notification of Requested Access Request Recommendations</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/ai-access-request-recommendations/requested-items"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The recommended access item that was requested for an identity.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Notification successfully acknowledged.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"2017-07-11T18:45:37.098Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Notification of Viewed Access Request Recommendations</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/ai-access-request-recommendations/viewed-items"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The recommended access that was viewed for an identity.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Recommendation successfully stored as viewed.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"2017-07-11T18:45:37.098Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Notification of Viewed Access Request Recommendations in Bulk</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/ai-access-request-recommendations/viewed-items/bulk-create"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The recommended access items that were viewed for an identity.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"identityId"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Recommendations successfully stored as viewed.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"The identity ID taking the action.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"ID of access item being recommended.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"AccessRequestRecommendationItemType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE"],"description":"The type of access item.","example":"ACCESS_PROFILE","title":"AccessRequestRecommendationItemType"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"identityId\": \"2c91808570313110017040b06f344ec9\",\n \"access\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"type\": \"ACCESS_PROFILE\"\n },\n \"timestamp\": \"2017-07-11T18:45:37.098Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
91
docs/api/beta/approve-access-request.api.mdx
Normal file
91
docs/api/beta/approve-access-request.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Approves an access request approval.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/access-request-approvals/{approvalId}/approve"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This endpoint approves an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"approvalId","schema":{"type":"string"},"required":true,"description":"The id of the approval.","example":"2c91808b7294bea301729568c68c002e"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Reviewer's comment.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Comment content.","example":"This is a comment."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>author</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"DTO type of the commenting identity.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the commenting identity.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of the commenting identity.","example":"Adam Kennedy"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date and time comment was created.","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
75
docs/api/beta/approve-approval-item.api.mdx
Normal file
75
docs/api/beta/approve-approval-item.api.mdx
Normal file
File diff suppressed because one or more lines are too long
75
docs/api/beta/approve-approval-items-in-bulk.api.mdx
Normal file
75
docs/api/beta/approve-approval-items-in-bulk.api.mdx
Normal file
File diff suppressed because one or more lines are too long
87
docs/api/beta/approve-non-employee-request.api.mdx
Normal file
87
docs/api/beta/approve-non-employee-request.api.mdx
Normal file
File diff suppressed because one or more lines are too long
85
docs/api/beta/bulk-delete-roles.api.mdx
Normal file
85
docs/api/beta/bulk-delete-roles.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Role(s)</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/roles/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"roleIds"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Roles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Returns an object with the id of the task performing the delete operation.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`TASK_RESULT`]"} schema={{"type":"string","description":"Task result DTO type.","enum":["TASK_RESULT"],"example":"TASK_RESULT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result ID.","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result display name.","nullable":true,"example":null}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"TASK_RESULT\",\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"name\": null\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"type\": \"TASK_RESULT\",\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"name\": null\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1 Bad Request Content"} value={"400.1 Bad Request Content"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"1ea1adcb84da4dcb890145e05745774e\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1 Role ids limit violation"} value={"400.1 Role ids limit violation"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"roleIds count exceeded max limit of 50 for bulk-delete.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1.404 Referenced object not found"} value={"400.1.404 Referenced object not found"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1.404 Referenced object not found\",\n \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"Referenced roleIds [\\\"2c91808876438bb2017668b91919ecca\\\"] was not found.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
100
docs/api/beta/cancel-access-request.api.mdx
Normal file
100
docs/api/beta/cancel-access-request.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Cancel Access Request</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/access-requests/cancel"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accountActivityId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for cancelling the pending access request.","example":"I requested this role by mistake."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/cancel-workflow-execution.api.mdx
Normal file
95
docs/api/beta/cancel-workflow-execution.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Cancel Workflow Execution by ID</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/workflow-executions/{id}/cancel"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Use this API to cancel a running workflow execution.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"The workflow execution ID","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
85
docs/api/beta/certification-campaigns.tag.mdx
Normal file
85
docs/api/beta/certification-campaigns.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
33
docs/api/beta/certifications.tag.mdx
Normal file
33
docs/api/beta/certifications.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
98
docs/api/beta/close-access-request.api.mdx
Normal file
98
docs/api/beta/close-access-request.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Close Access Request</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/access-requests/close"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessRequestIds"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request.","items":{"type":"string"},"example":["2c90ad2a70ace7d50170acf22ca90010"]}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Reason for closing the access request. Displayed under Warnings in IdentityNow.","default":"The IdentityNow Administrator manually closed this request.","example":"The IdentityNow Administrator manually closed this request."}}></SchemaItem><SchemaItem collapsible={false} name={"executionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Terminated`, `Completed`]"} schema={{"type":"string","enum":["Terminated","Completed"],"description":"The request's provisioning status. Displayed as Stage in IdentityNow.","default":"Terminated","example":"Terminated"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Incomplete`, `Failure`]"} schema={{"type":"string","enum":["Success","Incomplete","Failure"],"description":"The request's overall status. Displayed as Status in IdentityNow.","default":"Failure","example":"Failure"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
91
docs/api/beta/compare-identity-snapshots-access-type.api.mdx
Normal file
91
docs/api/beta/compare-identity-snapshots-access-type.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Gets a list of differences of specific accessType for the given identity between 2 snapshots</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"get"} path={"/historical-identities/{id}/compare/{access-type}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"accessType","schema":{"type":"string"},"required":true,"description":"The specific type which needs to be compared","example":"role"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"access-associated","schema":{"type":"boolean"},"description":"Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed","example":"2007-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"snapshot1","schema":{"type":"string"},"description":"The snapshot 1 of identity","example":"2008-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"snapshot2","schema":{"type":"string"},"description":"The snapshot 2 of identity","example":"2009-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
A list of events for the identity
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the access item"}}></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ADD`, `REMOVE`]"} schema={{"type":"string","enum":["ADD","REMOVE"]}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the display name of the access item"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the source name of the access item"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"2c91808c7726345b017726a0a2fb013b\",\n \"eventType\": \"ADD\",\n \"displayName\": \"Test\",\n \"sourceName\": \"Source\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/compare-identity-snapshots.api.mdx
Normal file
95
docs/api/beta/compare-identity-snapshots.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Gets a difference of count for each access item types for the given identity between 2 snapshots</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"get"} path={"/historical-identities/{id}/compare"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"snapshot1","schema":{"type":"string"},"description":"The snapshot 1 of identity","example":"2007-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"snapshot2","schema":{"type":"string"},"description":"The snapshot 2 of identity","example":"2008-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"accessItemTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned "}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
A IdentityCompare object with difference details for each access item type
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessItemDiff</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.
|
||||||
|
|
||||||
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"accessItemDiff\": {\n \"role\": {\n \"accessAdded\": 2,\n \"accessRemoved\": 3\n },\n \"entitlement\": {\n \"accessAdded\": 4,\n \"accessRemoved\": 0\n },\n \"accessProfile\": {\n \"accessAdded\": 0,\n \"accessRemoved\": 1\n }\n }\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
119
docs/api/beta/complete-campaign.api.mdx
Normal file
119
docs/api/beta/complete-campaign.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Complete a Campaign</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/campaigns/{id}/complete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
:::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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The campaign id","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"autoCompleteAction"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`APPROVE`, `REVOKE`]"} schema={{"description":"Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion.","type":"string","enum":["APPROVE","REVOKE"],"default":"APPROVE","example":"REVOKE"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/complete-trigger-invocation.api.mdx
Normal file
83
docs/api/beta/complete-trigger-invocation.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Complete Trigger Invocation</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/trigger-invocations/{id}/complete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Completes an invocation to a REQUEST_RESPONSE type trigger.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the invocation to complete.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"secret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The error message to indicate a failed invocation or error if any.","example":"Access request is denied."}}></SchemaItem><SchemaItem collapsible={false} name={"output"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","example":{"approved":false},"description":"Trigger output to complete the invocation. Its schema is defined in the trigger definition."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
75
docs/api/beta/complete-work-item.api.mdx
Normal file
75
docs/api/beta/complete-work-item.api.mdx
Normal file
File diff suppressed because one or more lines are too long
16
docs/api/beta/connector-rule-management.tag.mdx
Normal file
16
docs/api/beta/connector-rule-management.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
34
docs/api/beta/connectors.tag.mdx
Normal file
34
docs/api/beta/connectors.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
157
docs/api/beta/create-access-profile.api.mdx
Normal file
157
docs/api/beta/create-access-profile.api.mdx
Normal file
File diff suppressed because one or more lines are too long
131
docs/api/beta/create-access-request.api.mdx
Normal file
131
docs/api/beta/create-access-request.api.mdx
Normal file
File diff suppressed because one or more lines are too long
90
docs/api/beta/create-account.api.mdx
Normal file
90
docs/api/beta/create-account.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Account</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/accounts"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The schema attribute values for the account
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"sourceId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Target source to create an account","example":"34bfcbe116c9407464af37acbaf7a4dc"}}></SchemaItem><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Async task details
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808474683da6017468693c260195\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
183
docs/api/beta/create-campaign-template.api.mdx
Normal file
183
docs/api/beta/create-campaign-template.api.mdx
Normal file
File diff suppressed because one or more lines are too long
175
docs/api/beta/create-campaign.api.mdx
Normal file
175
docs/api/beta/create-campaign.api.mdx
Normal file
File diff suppressed because one or more lines are too long
83
docs/api/beta/create-common-access.api.mdx
Normal file
83
docs/api/beta/create-common-access.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create common access items</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/common-access"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"CommonAccessType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"],"title":"CommonAccessType"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access description","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner name"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner ID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"CommonAccessItemState"} qualifierMessage={"**Possible values:** [`CONFIRMED`, `DENIED`]"} schema={{"type":"string","enum":["CONFIRMED","DENIED"],"description":"State of common access item.","title":"CommonAccessItemState"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Returns details of the common access classification request.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common Access Item ID"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"CommonAccessType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`]"} schema={{"description":"Common access type (ROLE or ACCESS_PROFILE)","type":"string","enum":["ACCESS_PROFILE","ROLE"],"title":"CommonAccessType"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access description","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner name"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Common access owner ID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"CommonAccessItemState"} qualifierMessage={"**Possible values:** [`CONFIRMED`, `DENIED`]"} schema={{"type":"string","enum":["CONFIRMED","DENIED"],"description":"State of common access item.","title":"CommonAccessItemState"}}></SchemaItem><SchemaItem collapsible={false} name={"lastUpdated"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"reviewedByUser"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"lastReviewed"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdByUser"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"access\": {\n \"id\": \"string\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ownerName\": \"string\",\n \"ownerId\": \"string\"\n },\n \"status\": \"CONFIRMED\",\n \"lastUpdated\": \"string\",\n \"reviewedByUser\": true,\n \"lastReviewed\": \"string\",\n \"createdByUser\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
104
docs/api/beta/create-connector-rule.api.mdx
Normal file
104
docs/api/beta/create-connector-rule.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Connector Rule</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/connector-rules"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Creates a new connector rule.
|
||||||
|
A token with ORG_ADMIN authority is required to call this API.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The connector rule to create
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 128 characters`"} schema={{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`BuildMap`, `ConnectorAfterCreate`, `ConnectorAfterDelete`, `ConnectorAfterModify`, `ConnectorBeforeCreate`, `ConnectorBeforeDelete`, `ConnectorBeforeModify`, `JDBCBuildMap`, `JDBCOperationProvisioning`, `JDBCProvision`, `PeopleSoftHRMSBuildMap`, `PeopleSoftHRMSOperationProvisioning`, `PeopleSoftHRMSProvision`, `RACFPermissionCustomization`, `SAPBuildMap`, `SapHrManagerRule`, `SapHrOperationProvisioning`, `SapHrProvision`, `SuccessFactorsOperationProvisioning`, `WebServiceAfterOperationRule`, `WebServiceBeforeOperationRule`]"} schema={{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The rule's function signature. Describes the rule's input arguments and output (if any)
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>input</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>output</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourceCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
SourceCode
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the version of the code","example":"1.0"}}></SchemaItem><SchemaItem collapsible={false} name={"script"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
The created connector rule
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 128 characters`"} schema={{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`BuildMap`, `ConnectorAfterCreate`, `ConnectorAfterDelete`, `ConnectorAfterModify`, `ConnectorBeforeCreate`, `ConnectorBeforeDelete`, `ConnectorBeforeModify`, `JDBCBuildMap`, `JDBCOperationProvisioning`, `JDBCProvision`, `PeopleSoftHRMSBuildMap`, `PeopleSoftHRMSOperationProvisioning`, `PeopleSoftHRMSProvision`, `RACFPermissionCustomization`, `SAPBuildMap`, `SapHrManagerRule`, `SapHrOperationProvisioning`, `SapHrProvision`, `SuccessFactorsOperationProvisioning`, `WebServiceAfterOperationRule`, `WebServiceBeforeOperationRule`]"} schema={{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The rule's function signature. Describes the rule's input arguments and output (if any)
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>input</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>output</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourceCode</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
SourceCode
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the version of the code","example":"1.0"}}></SchemaItem><SchemaItem collapsible={false} name={"script"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"name\": \"WebServiceBeforeOperationRule\",\n \"description\": \"This rule does that\",\n \"type\": \"BuildMap\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"firstName\",\n \"description\": \"the first name of the identity\",\n \"type\": \"String\"\n }\n ],\n \"output\": {\n \"name\": \"firstName\",\n \"description\": \"the first name of the identity\",\n \"type\": \"String\"\n }\n },\n \"sourceCode\": {\n \"version\": \"1.0\",\n \"script\": \"return \\\"Mr. \\\" + firstName;\"\n },\n \"attributes\": {},\n \"id\": \"8113d48c0b914f17b4c6072d4dcb9dfe\",\n \"created\": \"021-07-22T15:59:23Z\",\n \"modified\": \"021-07-22T15:59:23Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
75
docs/api/beta/create-custom-password-instructions.api.mdx
Normal file
75
docs/api/beta/create-custom-password-instructions.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Custom Password Instructions</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/custom-password-instructions"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"pageId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`change-password:enter-password`, `change-password:finish`, `flow-selection:select`, `forget-username:user-email`, `mfa:enter-code`, `mfa:enter-kba`, `mfa:select`, `reset-password:enter-password`, `reset-password:enter-username`, `reset-password:finish`, `unlock-account:enter-username`, `unlock-account:finish`]"} schema={{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]}}></SchemaItem><SchemaItem collapsible={false} name={"pageContent"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like <A HREF=\\\"URL\\\">...</A> 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: <a href=\\\"URL\" target=\\\"_blank\\\" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Reference to the custom password instructions.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"pageId"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`change-password:enter-password`, `change-password:finish`, `flow-selection:select`, `forget-username:user-email`, `mfa:enter-code`, `mfa:enter-kba`, `mfa:select`, `reset-password:enter-password`, `reset-password:enter-username`, `reset-password:finish`, `unlock-account:enter-username`, `unlock-account:finish`]"} schema={{"type":"string","description":"The page ID that represents the page for forget user name, reset password and unlock account flow.","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]}}></SchemaItem><SchemaItem collapsible={false} name={"pageContent"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like <A HREF=\\\"URL\\\">...</A> 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: <a href=\\\"URL\" target=\\\"_blank\\\" >link</a>. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target."}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"en","description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"pageId\": \"change-password:enter-password\",\n \"pageContent\": \"string\",\n \"locale\": \"en\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"pageId\": \"reset-password:enter-password\",\n \"locale\": \"default\",\n \"pageContent\": \"See company password policies for details by clicking <a href=\\\"url\\\">here</a>\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
87
docs/api/beta/create-domain-dkim.api.mdx
Normal file
87
docs/api/beta/create-domain-dkim.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Verify domain address via DKIM</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/verified-domains"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"domain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sailpoint.com","description":"A domain address"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
List of DKIM tokens required for the verification process.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123b45b0-aaaa-bbbb-a7db-123456a56abc","description":"New UUID associated with domain to be verified"}}></SchemaItem><SchemaItem collapsible={false} name={"domain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sailpoint.com","description":"A domain address"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimEnabled"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"default":false,"example":true,"description":"DKIM is enabled for this domain"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimTokens"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["token1","token2","token3"],"description":"DKIM tokens required for authentication"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimVerificationStatus"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"PENDING","description":"Status of DKIM authentication"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"123b45b0-aaaa-bbbb-a7db-123456a56abc\",\n \"domain\": \"sailpoint.com\",\n \"dkimEnabled\": true,\n \"dkimTokens\": [\n \"token1\",\n \"token2\",\n \"token3\"\n ],\n \"dkimVerificationStatus\": \"PENDING\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"405"} value={"405"}><div>
|
||||||
|
|
||||||
|
Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorName"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"NotSupportedException"}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessage"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Description of the error","example":"Cannot consume content type"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"errorName\": \"NotSupportedException\",\n \"errorMessage\": \"Cannot consume content type\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
71
docs/api/beta/create-form-definition-dynamic-schema.api.mdx
Normal file
71
docs/api/beta/create-form-definition-dynamic-schema.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Generate JSON Schema dynamically.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/form-definitions/forms-action-dynamic-schema"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Generate JSON Schema dynamically.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Body is the request payload to create a form definition dynamic schema
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"formDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description is the form definition dynamic schema description text","example":"A description","type":"string","x-go-name":"Description"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Type is the form definition dynamic schema type","example":"action","type":"string","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"versionNumber"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"VersionNumber is the form definition dynamic schema version number","example":1,"format":"int64","type":"integer","x-go-name":"VersionNumber"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Returns a form elements dynamic schema
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>outputSchema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
OutputSchema holds a JSON schema generated dynamically
|
||||||
|
|
||||||
|
</div></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"outputSchema\": {\n \"outputSchema\": {\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"properties\": {\n \"firstName\": {\n \"title\": \"First Name\",\n \"type\": \"string\"\n },\n \"fullName\": {\n \"title\": \"Full Name\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Last Name\",\n \"type\": \"string\"\n },\n \"startDate\": {\n \"format\": \"date-time\",\n \"title\": \"Start Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
An error with the request occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
An error with the authorization occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
An error with the user permissions occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
An error with the item not found
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too many requests
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"Internal Server Error\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
An internal server error occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
75
docs/api/beta/create-form-definition-file-request.api.mdx
Normal file
75
docs/api/beta/create-form-definition-file-request.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Upload new form definition file.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/form-definitions/{formDefinitionID}/upload"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Parameter `{formDefinitionID}` should match a form definition ID.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"formDefinitionID","in":"path","description":"FormDefinitionID\n\nString specifying FormDefinitionID","required":true,"example":"00000000-0000-0000-0000-000000000000","schema":{"type":"string","x-go-name":"FormDefinitionID"},"x-go-name":"FormDefinitionID"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"file"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","description":"File specifying the multipart","format":"binary","x-go-name":"File"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Returns a new form definition file
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Created is the date the file was uploaded","example":"2023-07-12T20:14:57.74486Z","x-go-name":"Created"}}></SchemaItem><SchemaItem collapsible={false} name={"fileId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"fileId is a unique ULID that serves as an identifier for the form definition file","example":"01FHZXHK8PTP9FVK99Z66GXQTX.png","x-go-name":"FileID"}}></SchemaItem><SchemaItem collapsible={false} name={"formDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"created\": \"2023-07-12T20:14:57.74486Z\",\n \"fileId\": \"01FHZXHK8PTP9FVK99Z66GXQTX.png\",\n \"formDefinitionId\": \"00000000-0000-0000-0000-000000000000\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
An error with the request occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
An error with the authorization occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
An error with the user permissions occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
An error with the item not found
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"413"} value={"413"}><div>
|
||||||
|
|
||||||
|
An error with payload size too large
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"415"} value={"415"}><div>
|
||||||
|
|
||||||
|
An error with unsupported media type
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too many requests
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"Internal Server Error\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
An internal server error occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"503"} value={"503"}><div>
|
||||||
|
|
||||||
|
An external service is not available
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
127
docs/api/beta/create-form-definition.api.mdx
Normal file
127
docs/api/beta/create-form-definition.api.mdx
Normal file
File diff suppressed because one or more lines are too long
115
docs/api/beta/create-form-instance.api.mdx
Normal file
115
docs/api/beta/create-form-instance.api.mdx
Normal file
File diff suppressed because one or more lines are too long
103
docs/api/beta/create-identity-attribute.api.mdx
Normal file
103
docs/api/beta/create-identity-attribute.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Identity Attribute</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/identity-attributes"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This creates a new identity attribute.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The technical name of the identity attribute","example":"uid"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The business-friendly name of the identity attribute","example":"IdentityNow Username"}}></SchemaItem><SchemaItem collapsible={false} name={"standard"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the attribute is 'standard' or default","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the identity attribute","example":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"multi"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the identity attribute is multi-valued","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"searchable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the identity attribute is searchable","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"system"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows this is 'system' identity attribute that does not have a source and is not configurable.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sources</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of sources for an attribute, this specifies how the value of the rule is derived
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source","example":"rule"}}></SchemaItem><SchemaItem collapsible={false} name={"properties"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The source properties","example":{"attribute":null,"sourceName":"Employees"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
The identity attribute was created successfully
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The technical name of the identity attribute","example":"uid"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The business-friendly name of the identity attribute","example":"IdentityNow Username"}}></SchemaItem><SchemaItem collapsible={false} name={"standard"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the attribute is 'standard' or default","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the identity attribute","example":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"multi"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the identity attribute is multi-valued","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"searchable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows if the identity attribute is searchable","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"system"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Shows this is 'system' identity attribute that does not have a source and is not configurable.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sources</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of sources for an attribute, this specifies how the value of the rule is derived
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source","example":"rule"}}></SchemaItem><SchemaItem collapsible={false} name={"properties"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The source properties","example":{"attribute":null,"sourceName":"Employees"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"name\": \"uid\",\n \"displayName\": \"IdentityNow Username\",\n \"standard\": true,\n \"type\": \"string\",\n \"multi\": false,\n \"searchable\": true,\n \"system\": false,\n \"sources\": [\n {\n \"type\": \"rule\",\n \"properties\": {\n \"attribute\": null,\n \"sourceName\": \"Employees\"\n }\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
116
docs/api/beta/create-identity-profile.api.mdx
Normal file
116
docs/api/beta/create-identity-profile.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create an Identity Profile</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/identity-profiles"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This creates an Identity Profile
|
||||||
|
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The owner of the Identity Profile.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authoritativeSource</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The authoritative source for this Identity Profile.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityRefreshRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityAttributeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeTransforms</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transformDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The seaspray transformation definition
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Arbitrary key-value pairs to store any metadata for the object
|
||||||
|
|
||||||
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityExceptionReportReference</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskResultId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"}}></SchemaItem><SchemaItem collapsible={false} name={"reportName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My annual report","description":"The name of the report"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasTimeBasedAttr"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
The created Identity Profile
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","format":"date-time","readOnly":true,"example":"2023-01-03T21:16:22.432Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The description of the Identity Profile.","example":"My custom flat file profile"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The owner of the Identity Profile.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the object to which this reference applies","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"priority"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"The priority for an Identity Profile.","example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authoritativeSource</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The authoritative source for this Identity Profile.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type of the object to which this reference applies","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"HR Active Directory"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityRefreshRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if a identity refresh is needed. Typically triggered when a change on the source has been made","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities that belong to the Identity Profile.","format":"int32","example":8}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityAttributeConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the profile or mapping is enabled","example":true,"default":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeTransforms</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute","example":"email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>transformDefinition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The seaspray transformation definition
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the transform definition.","example":"accountAttribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Arbitrary key-value pairs to store any metadata for the object
|
||||||
|
|
||||||
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"Arbitrary key-value pairs to store any metadata for the object","example":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityExceptionReportReference</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskResultId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the task result","example":"2c918086795cd09201795d5f7d7533df"}}></SchemaItem><SchemaItem collapsible={false} name={"reportName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"My annual report","description":"The name of the report"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasTimeBasedAttr"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.","type":"boolean","default":true,"example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2023-01-03T21:16:22.432Z\",\n \"modified\": \"2023-01-03T21:16:22.432Z\",\n \"description\": \"My custom flat file profile\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"William Wilson\"\n },\n \"priority\": 10,\n \"authoritativeSource\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n },\n \"identityRefreshRequired\": true,\n \"identityCount\": 8,\n \"identityAttributeConfig\": {\n \"enabled\": true,\n \"attributeTransforms\": [\n {\n \"identityAttributeName\": \"email\",\n \"transformDefinition\": {\n \"type\": \"accountAttribute\",\n \"attributes\": {\n \"attributeName\": \"e-mail\",\n \"sourceName\": \"MySource\",\n \"sourceId\": \"2c9180877a826e68017a8c0b03da1a53\"\n }\n }\n }\n ]\n },\n \"identityExceptionReportReference\": {\n \"taskResultId\": \"2c918086795cd09201795d5f7d7533df\",\n \"reportName\": \"My annual report\"\n },\n \"hasTimeBasedAttr\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
97
docs/api/beta/create-non-employee-record.api.mdx
Normal file
97
docs/api/beta/create-non-employee-record.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Non-Employee Record</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/non-employee-records"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This request will create a non-employee record.
|
||||||
|
Request will require the following security scope:
|
||||||
|
'idn:nesr:create'
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Non-Employee record creation request body.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accountName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name.","example":"william.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.
|
||||||
|
|
||||||
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Created non-employee record.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee record id."}}></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name."}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Attribute blob/bag for a non-employee.
|
||||||
|
|
||||||
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2020-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {},\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
103
docs/api/beta/create-non-employee-request.api.mdx
Normal file
103
docs/api/beta/create-non-employee-request.api.mdx
Normal file
File diff suppressed because one or more lines are too long
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Non-Employee Source Schema Attribute</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/non-employee-sources/{sourceId}/schema-attributes"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of the attribute. Only type 'TEXT' is supported for custom attributes.","example":"TEXT"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"}}></SchemaItem><SchemaItem collapsible={false} name={"technicalName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"}}></SchemaItem><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"}}></SchemaItem><SchemaItem collapsible={false} name={"placeholder"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Schema Attribute created.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"}}></SchemaItem><SchemaItem collapsible={false} name={"system"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"NonEmployeeSchemaAttributeType"} qualifierMessage={"**Possible values:** [`TEXT`, `DATE`, `IDENTITY`]"} schema={{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","title":"NonEmployeeSchemaAttributeType"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"}}></SchemaItem><SchemaItem collapsible={false} name={"technicalName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"}}></SchemaItem><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"}}></SchemaItem><SchemaItem collapsible={false} name={"placeholder"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"type\": \"TEXT\",\n \"label\": \"Account Name\",\n \"technicalName\": \"account.name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
117
docs/api/beta/create-non-employee-source.api.mdx
Normal file
117
docs/api/beta/create-non-employee-source.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Non-Employee Source</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/non-employee-sources"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This request will create a non-employee source.
|
||||||
|
Request will require the following security scope:
|
||||||
|
'idn:nesr:create'
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Non-Employee source creation request body.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Owner of non-employee source.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"managementWorkgroup"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID for the management workgroup that contains source sub-admins","example":"123299"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
**Possible values:** `<= 3`
|
||||||
|
|
||||||
|
</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of approvers.
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
**Possible values:** `<= 10`
|
||||||
|
|
||||||
|
</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of account managers.
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Identity id.","example":"2c91808570313110017040b06f344ec9"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Created non-employee source.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of approvers
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of account managers
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"nonEmployeeCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"nullable":true,"type":"integer","description":"The number of non-employee records on all sources that *requested-for* user manages.","example":2,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"cloudExternalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present.","example":"99999"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeCount\": 2,\n \"cloudExternalId\": \"99999\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
85
docs/api/beta/create-notification-template.api.mdx
Normal file
85
docs/api/beta/create-notification-template.api.mdx
Normal file
File diff suppressed because one or more lines are too long
83
docs/api/beta/create-oauth-client.api.mdx
Normal file
83
docs/api/beta/create-oauth-client.api.mdx
Normal file
File diff suppressed because one or more lines are too long
85
docs/api/beta/create-password-org-config.api.mdx
Normal file
85
docs/api/beta/create-password-org-config.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Password Org Config</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/password-org-config"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"customInstructionsEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenDurationMinutes"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 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}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenLength"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 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}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Reference to the password org config.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"customInstructionsEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether custom password instructions feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicator whether \"digit token\" feature is enabled. The default value is false.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenDurationMinutes"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 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}}></SchemaItem><SchemaItem collapsible={false} name={"digitTokenLength"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 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}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"customInstructionsEnabled\": true,\n \"digitTokenEnabled\": true,\n \"digitTokenDurationMinutes\": 10,\n \"digitTokenLength\": 9\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"customInstructionsEnabled\": true,\n \"digitTokenDurationMinutes\": 9,\n \"digitTokenEnabled\": true,\n \"digitTokenLength\": 12\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/create-password-sync-group.api.mdx
Normal file
83
docs/api/beta/create-password-sync-group.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Password Sync Group</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/password-sync-groups"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"}}></SchemaItem><SchemaItem collapsible={false} name={"passwordPolicyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was created","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was last modified","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Reference to the password sync group.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the sync group","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the sync group","type":"string","example":"Password Sync Group 1"}}></SchemaItem><SchemaItem collapsible={false} name={"passwordPolicyId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the password policy","example":"2c91808d744ba0ce01746f93b6204501"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of password managed sources IDs","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was created","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time this sync group was last modified","format":"date-time","example":"2023-03-16T04:00:00Z","nullable":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"6881f631-3bd5-4213-9c75-8e05cc3e35dd\",\n \"name\": \"Password Sync Group 1\",\n \"passwordPolicyId\": \"2c91808d744ba0ce01746f93b6204501\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ],\n \"created\": \"2023-03-16T04:00:00Z\",\n \"modified\": \"2023-03-16T04:00:00Z\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"id\": \"6881f631-3bd5-4213-9c75-8e05cc3e35dd\",\n \"name\": \"Password Sync Group 2\",\n \"passwordPolicyId\": \"2c91808d744ba0ce01746f93b6204501\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
91
docs/api/beta/create-personal-access-token.api.mdx
Normal file
91
docs/api/beta/create-personal-access-token.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Personal Access Token</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/personal-access-tokens"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This creates a personal access token.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Name and scope of personal access token.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created.","example":"NodeJS Integration"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the personal access token (to be used as the username for Basic Auth).","example":"86f1dc6fe8f54414950454cbb11278fa"}}></SchemaItem><SchemaItem collapsible={false} name={"secret"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The secret of the personal access token (to be used as the password for Basic Auth).","example":"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"string","default":"sp:scopes:all"},"description":"Scopes of the personal access token.","example":["demo:personal-access-token-scope:first","demo:personal-access-token-scope:second"]}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the personal access token. Cannot be the same as other personal access tokens owned by a user.","example":"NodeJS Integration"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Personal access token owner's identity.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Personal access token owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Personal access token owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Personal access token owner's human-readable display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time, down to the millisecond, when this personal access token was created.","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"86f1dc6fe8f54414950454cbb11278fa\",\n \"secret\": \"1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9\",\n \"scope\": [\n \"demo:personal-access-token-scope:first\",\n \"demo:personal-access-token-scope:second\"\n ],\n \"name\": \"NodeJS Integration\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"created\": \"2017-07-11T18:45:37.098Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
107
docs/api/beta/create-potential-role-provision-request.api.mdx
Normal file
107
docs/api/beta/create-potential-role-provision-request.api.mdx
Normal file
File diff suppressed because one or more lines are too long
98
docs/api/beta/create-provisioning-policy.api.mdx
Normal file
98
docs/api/beta/create-provisioning-policy.api.mdx
Normal file
File diff suppressed because one or more lines are too long
107
docs/api/beta/create-reassignment-configuration.api.mdx
Normal file
107
docs/api/beta/create-reassignment-configuration.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create a Reassignment Configuration</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/reassignment-configurations"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Creates a new Reassignment Configuration for the specified identity.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"reassignedFromId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity id to reassign an item from","example":"2c91808781a71ddb0181b9090b5c504e"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignedToId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity id to reassign an item to","example":"2c91808781a71ddb0181b9090b53504a"}}></SchemaItem><SchemaItem collapsible={false} name={"configType"} required={false} schemaName={"ConfigTypeEnum"} qualifierMessage={"**Possible values:** [`ACCESS_REQUESTS`, `CERTIFICATIONS`, `MANUAL_TASKS`]"} schema={{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS","title":"ConfigTypeEnum"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment.","format":"date-time","nullable":true,"example":"2022-07-30T17:00:00.000Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
The newly created Reassignment Configuration object
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The definition of an Identity according to the Reassignment Configuration service
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>configDetails</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Details of how work should be reassigned for an Identity
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"configType"} required={false} schemaName={"ConfigTypeEnum"} qualifierMessage={"**Possible values:** [`ACCESS_REQUESTS`, `CERTIFICATIONS`, `MANUAL_TASKS`]"} schema={{"type":"string","description":"Enum list of valid work types that can be selected for a Reassignment Configuration","enum":["ACCESS_REQUESTS","CERTIFICATIONS","MANUAL_TASKS"],"example":"ACCESS_REQUESTS","title":"ConfigTypeEnum"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>targetIdentity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The definition of an Identity according to the Reassignment Configuration service
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to start reassigning work items","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment.","format":"date-time","example":"0001-01-01T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>auditDetails</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Audit details for the reassignment configuration of an identity
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Initial date and time when the record was created","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The definition of an Identity according to the Reassignment Configuration service
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Last modified date and time for the record","format":"date-time","example":"2022-07-21T11:13:12.345Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>modifiedBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The definition of an Identity according to the Reassignment Configuration service
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the object","example":"2c91808380aa05580180aaaaf1940410"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"identity\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"configDetails\": [\n {\n \"configType\": \"ACCESS_REQUESTS\",\n \"targetIdentity\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"startDate\": \"2022-07-21T11:13:12.345Z\",\n \"endDate\": \"0001-01-01T00:00:00Z\",\n \"auditDetails\": {\n \"created\": \"2022-07-21T11:13:12.345Z\",\n \"createdBy\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n },\n \"modified\": \"2022-07-21T11:13:12.345Z\",\n \"modifiedBy\": {\n \"id\": \"2c91808380aa05580180aaaaf1940410\",\n \"name\": \"William Wilson\"\n }\n }\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
87
docs/api/beta/create-role-insight-requests.api.mdx
Normal file
87
docs/api/beta/create-role-insight-requests.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Generate insights for roles</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/role-insights/requests"}></MethodEndpoint>
|
||||||
|
|
||||||
|
:::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
|
||||||
|
|
||||||
|
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Submitted a role insights generation request
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request Id for a role insight generation request","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"createdDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was created.","example":"2020-09-16T18:49:32.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastGenerated"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was completed.","example":"2020-09-16T18:50:12.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"numberOfUpdates"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The role IDs that are in this request.","type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `IN PROGRESS`, `COMPLETED`, `FAILED`]"} schema={{"type":"string","description":"Request status","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"c9aa02f7-86b0-4bc4-84bd-3116a6131e77\",\n \"createdDate\": \"2020-09-16T18:49:32.150Z\",\n \"lastGenerated\": \"2020-09-16T18:49:32.150Z\",\n \"numberOfUpdates\": 0,\n \"roleIds\": [\n \"2c91808e720e94f8017253287c0a44f4\",\n \"2c918087723ac2800172532191540e03\",\n \"2c9180986e4c8592016e6b15eaef447c\"\n ],\n \"status\": \"CREATED\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
111
docs/api/beta/create-role-mining-sessions.api.mdx
Normal file
111
docs/api/beta/create-role-mining-sessions.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create a role mining session</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/role-mining-sessions"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This submits a create role mining session request to the role mining application.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Role mining session parameters
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>scope</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The scope of identities for this role mining session
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]}}></SchemaItem><SchemaItem collapsible={false} name={"criteria"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","nullable":true,"example":"source.name:DataScienceDataset"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeFilterCriteria"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","nullable":true,"example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"pruneThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","nullable":true,"example":5,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"prescribedPruneThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The calculated prescribedPruneThreshold","nullable":true,"example":10,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"minNumIdentitiesInPotentialRole"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum number of identities in a potential role","nullable":true,"example":20,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRoleCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of potential roles","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRolesReadyCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of potential roles ready","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The status of the role mining session
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"RoleMiningSessionState"} qualifierMessage={"**Possible values:** [`CREATED`, `UPDATED`, `IDENTITIES_OBTAINED`, `PRUNE_THRESHOLD_OBTAINED`, `POTENTIAL_ROLES_PROCESSING`, `POTENTIAL_ROLES_CREATED`]"} schema={{"description":"Role mining session state","type":"string","enum":["CREATED","UPDATED","IDENTITIES_OBTAINED","PRUNE_THRESHOLD_OBTAINED","POTENTIAL_ROLES_PROCESSING","POTENTIAL_ROLES_CREATED"],"example":"CREATED","title":"RoleMiningSessionState"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining session type","example":"SPECIALIZED","type":"string","enum":["SPECIALIZED","COMMON"],"title":"RoleMiningRoleType"}}></SchemaItem><SchemaItem collapsible={false} name={"emailRecipientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the user who will receive an email about the role mining session","nullable":true,"example":"2c918090761a5aac0176215c46a62d58"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>createdBy</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The session created by details
|
||||||
|
|
||||||
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"EntityCreatedByDTO"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}></SchemaItem></TabItem><TabItem label={"NullableEntityCreatedByDTO"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
string
|
||||||
|
|
||||||
|
</div></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of identities in the population which meet the search criteria or identity list provided","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The session's saved status","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The session's saved name","nullable":true,"example":"Saved RM Session - 07/10"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Submitted a role mining session request
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>scope</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The scope of identities for this role mining session
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]}}></SchemaItem><SchemaItem collapsible={false} name={"criteria"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","nullable":true,"example":"source.name:DataScienceDataset"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeFilterCriteria"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","nullable":true,"example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"minNumIdentitiesInPotentialRole"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum number of identities in a potential role","example":20}}></SchemaItem><SchemaItem collapsible={false} name={"prescribedPruneThreshold"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The computed (or prescribed) prune threshold for this session","example":83}}></SchemaItem><SchemaItem collapsible={false} name={"pruneThreshold"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The prune threshold to be used for this role mining session","example":70}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRoleCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of potential roles","example":8}}></SchemaItem><SchemaItem collapsible={false} name={"potentialRolesReadyCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of potential roles which have completed processing","example":4}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The role mining session status
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"RoleMiningSessionState"} qualifierMessage={"**Possible values:** [`CREATED`, `UPDATED`, `IDENTITIES_OBTAINED`, `PRUNE_THRESHOLD_OBTAINED`, `POTENTIAL_ROLES_PROCESSING`, `POTENTIAL_ROLES_CREATED`]"} schema={{"description":"Role mining session state","type":"string","enum":["CREATED","UPDATED","IDENTITIES_OBTAINED","PRUNE_THRESHOLD_OBTAINED","POTENTIAL_ROLES_PROCESSING","POTENTIAL_ROLES_CREATED"],"example":"CREATED","title":"RoleMiningSessionState"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Session Id for this role mining session","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"createdDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time when this role mining session was created."}}></SchemaItem><SchemaItem collapsible={false} name={"modifiedDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time when this role mining session was completed."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining session type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED","title":"RoleMiningRoleType"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"scope\": {\n \"identityIds\": [],\n \"criteria\": \"source.name:DataScienceDataset\"\n },\n \"minNumIdentitiesInPotentialRole\": 20,\n \"pruneThreshold\": 70,\n \"prescribedPruneThreshold\": 83,\n \"potentialRoleCount\": 8,\n \"potentialRolesReadyCount\": 4,\n \"status\": {\n \"state\": \"POTENTIAL_ROLES_PROCESSING\"\n },\n \"id\": \"602ba738-cf48-499b-a780-7b67b3fc1ecf\",\n \"createdDate\": \"2021-09-08T16:11:05.348Z\",\n \"modifiedDate\": \"2021-09-08T16:11:05.348Z\",\n \"type\": \"SPECIALIZED\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
198
docs/api/beta/create-role.api.mdx
Normal file
198
docs/api/beta/create-role.api.mdx
Normal file
File diff suppressed because one or more lines are too long
100
docs/api/beta/create-search-attribute-config.api.mdx
Normal file
100
docs/api/beta/create-search-attribute-config.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Configure/create extended search attributes in IdentityNow.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/accounts/search-attribute-config"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the new attribute","example":"newMailAttribute"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the new attribute","example":"New Mail Attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"applicationAttributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Map of application id and their associated attribute.","example":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber","2c91808b79fd2422017a0b36008f396b":"employeeNumber"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
101
docs/api/beta/create-segment.api.mdx
Normal file
101
docs/api/beta/create-segment.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Segment</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/segments"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's business name.","example":"segment-xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when the segment is created.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when the segment is modified.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's optional description.","example":"This segment represents xyz"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The owner of this object.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>visibilityCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>expression</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AND`, `EQUALS`]"} schema={{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name for the attribute","example":"location"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>value</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of attribute value","example":"STRING"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute value","example":"Austin"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>children</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of expressions
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of attribute value","example":"STRING"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute value","example":"Austin"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"This boolean indicates whether the segment is currently active. Inactive segments have no effect.","default":false,"example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
Segment created
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's business name.","example":"segment-xyz"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when the segment is created.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when the segment is modified.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The segment's optional description.","example":"This segment represents xyz"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
The owner of this object.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>visibilityCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>expression</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"operator"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AND`, `EQUALS`]"} schema={{"type":"string","description":"Operator for the expression","enum":["AND","EQUALS"],"example":"EQUALS"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name for the attribute","example":"location"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>value</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of attribute value","example":"STRING"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute value","example":"Austin"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>children</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of expressions
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of attribute value","example":"STRING"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute value","example":"Austin"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"This boolean indicates whether the segment is currently active. Inactive segments have no effect.","default":false,"example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"segment-xyz\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\",\n \"description\": \"This segment represents xyz\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"support\"\n },\n \"visibilityCriteria\": {\n \"expression\": {\n \"operator\": \"EQUALS\",\n \"attribute\": \"location\",\n \"value\": {\n \"type\": \"STRING\",\n \"value\": \"Austin\"\n },\n \"children\": []\n }\n },\n \"active\": true\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/create-send-token.api.mdx
Normal file
83
docs/api/beta/create-send-token.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create and send user token</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/mfa/token/send"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This API send token request.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"userAlias"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":false,"type":"string","description":"User alias from table spt_identity field named 'name'","example":"will.albin"}}></SchemaItem><SchemaItem collapsible={false} name={"deliveryType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`SMS_PERSONAL`, `VOICE_PERSONAL`, `SMS_WORK`, `VOICE_WORK`, `EMAIL_WORK`, `EMAIL_PERSONAL`]"} schema={{"nullable":false,"type":"string","enum":["SMS_PERSONAL","VOICE_PERSONAL","SMS_WORK","VOICE_WORK","EMAIL_WORK","EMAIL_PERSONAL"],"description":"Token delivery type","example":"EMAIL_WORK"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Token send status.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The token request ID","example":"089899f13a8f4da7824996191587bab9"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILED`]"} schema={{"type":"string","enum":["SUCCESS","FAILED"],"description":"Status of sending token","example":"SUCCESS"}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Error messages from token send request","example":"Unable to sent text message"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"requestId\": \"089899f13a8f4da7824996191587bab9\",\n \"status\": \"SUCCESS\",\n \"errorMessage\": \"Unable to sent text message\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"requestId\": \"089899f13a8f4da7824996191587bab9\",\n \"status\": \"SUCCESS\",\n \"errorMessage\": \"\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
155
docs/api/beta/create-service-desk-integration.api.mdx
Normal file
155
docs/api/beta/create-service-desk-integration.api.mdx
Normal file
File diff suppressed because one or more lines are too long
120
docs/api/beta/create-sod-policy.api.mdx
Normal file
120
docs/api/beta/create-sod-policy.api.mdx
Normal file
File diff suppressed because one or more lines are too long
99
docs/api/beta/create-source-schema.api.mdx
Normal file
99
docs/api/beta/create-source-schema.api.mdx
Normal file
File diff suppressed because one or more lines are too long
164
docs/api/beta/create-source.api.mdx
Normal file
164
docs/api/beta/create-source.api.mdx
Normal file
File diff suppressed because one or more lines are too long
117
docs/api/beta/create-subscription.api.mdx
Normal file
117
docs/api/beta/create-subscription.api.mdx
Normal file
File diff suppressed because one or more lines are too long
563
docs/api/beta/create-transform.api.mdx
Normal file
563
docs/api/beta/create-transform.api.mdx
Normal file
File diff suppressed because one or more lines are too long
83
docs/api/beta/create-verified-from-address.api.mdx
Normal file
83
docs/api/beta/create-verified-from-address.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create Verified From Address</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/verified-from-addresses"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Create a new sender email address and initiate verification process.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sender@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `SUCCESS`, `FAILED`]"} schema={{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||||
|
|
||||||
|
New Verified Email Status
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sender@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `SUCCESS`, `FAILED`]"} schema={{"type":"string","enum":["PENDING","SUCCESS","FAILED"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"email\": \"sender@example.com\",\n \"verificationStatus\": \"PENDING\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
127
docs/api/beta/create-workflow.api.mdx
Normal file
127
docs/api/beta/create-workflow.api.mdx
Normal file
File diff suppressed because one or more lines are too long
91
docs/api/beta/create-workgroup.api.mdx
Normal file
91
docs/api/beta/create-workgroup.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Create a new Governance Group.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/workgroups"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This API creates a new Governance Group.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Owner's identity.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group name.","example":"DB Access Governance Group"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group description.","example":"Description of the Governance Group"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Governance Group object created.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Owner's identity.
|
||||||
|
|
||||||
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group ID.","example":"2c91808568c529c60168cca6f90c1313","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group name.","example":"DB Access Governance Group"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group description.","example":"Description of the Governance Group"}}></SchemaItem><SchemaItem collapsible={false} name={"memberCount"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","example":1641498673000,"readOnly":true,"description":"Number of members in the governance group."}}></SchemaItem><SchemaItem collapsible={false} name={"connectionCount"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the governance group.","readOnly":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"DB Access Governance Group\",\n \"description\": \"Description of the Governance Group\",\n \"memberCount\": 1641498673000,\n \"connectionCount\": 1641498673000\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
28
docs/api/beta/custom-forms.tag.mdx
Normal file
28
docs/api/beta/custom-forms.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
31
docs/api/beta/custom-password-instructions.tag.mdx
Normal file
31
docs/api/beta/custom-password-instructions.tag.mdx
Normal file
@@ -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';
|
||||||
|
|
||||||
|
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||||
|
```
|
||||||
|
|
||||||
87
docs/api/beta/delete-access-profile.api.mdx
Normal file
87
docs/api/beta/delete-access-profile.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete the specified Access Profile</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/access-profiles/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the Access Profile to delete","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Returned when an access profile cannot be deleted as it's being used.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.2.1.0 Object in use by another"} value={"400.2.1.0 Object in use by another"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.2.1.0 Object in use by another\",\n \"trackingId\": \"c9c1033c55b84ebc9e93e926dcf8b8b3\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The \\\"testAccessProfile\\\" access profile can't be deleted because it's in use.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
107
docs/api/beta/delete-access-profiles-in-bulk.api.mdx
Normal file
107
docs/api/beta/delete-access-profiles-in-bulk.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Access Profile(s)</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/access-profiles/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accessProfileIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Access Profiles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}}></SchemaItem><SchemaItem collapsible={false} name={"bestEffortOnly"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.","type":"boolean","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"}}></SchemaItem><SchemaItem collapsible={false} name={"pending"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inUse</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of usages of Access Profiles targeted for deletion.
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accessProfileId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of references to objects which are using the indicated Access Profile
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ROLE`]"} schema={{"type":"string","description":"DTO type of role using the access profile.","enum":["ROLE"],"example":"ROLE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of role using the access profile.","example":"2c8180857a9b3da0017aa03418480f9d"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of role using the access profile.","example":"Manager Role"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"taskId\": \"2c9180867817ac4d017817c491119a20\",\n \"pending\": [\n \"2c91808876438bbb017668c21919ecca\",\n \"2c91808876438bb201766e129f151816\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438bbb017668c21919ecca\",\n \"usedBy\": [\n {\n \"type\": \"ROLE\",\n \"id\": \"2c8180857a9b3da0017aa03418480f9d\",\n \"name\": \"Manager Role\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"pending\": [],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438ba801766e129f151816\",\n \"usages\": [\n {\n \"type\": \"Role\",\n \"id\": \"2c9180887643764201766e9f6e121518\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Returned if at least one deletion will be performed.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"taskId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"}}></SchemaItem><SchemaItem collapsible={false} name={"pending"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inUse</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of usages of Access Profiles targeted for deletion.
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accessProfileId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
List of references to objects which are using the indicated Access Profile
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ROLE`]"} schema={{"type":"string","description":"DTO type of role using the access profile.","enum":["ROLE"],"example":"ROLE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of role using the access profile.","example":"2c8180857a9b3da0017aa03418480f9d"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of role using the access profile.","example":"Manager Role"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"taskId\": \"2c9180867817ac4d017817c491119a20\",\n \"pending\": [\n \"2c91808876438bbb017668c21919ecca\",\n \"2c91808876438bb201766e129f151816\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438bbb017668c21919ecca\",\n \"usedBy\": [\n {\n \"type\": \"ROLE\",\n \"id\": \"2c8180857a9b3da0017aa03418480f9d\",\n \"name\": \"Manager Role\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"taskId\": \"2c91808a7813090a01781412a1119a20\",\n \"pending\": [\n \"2c91808a7813090a017813fe1919ecca\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438ba801766e129f151816\",\n \"usages\": [\n {\n \"type\": \"Role\",\n \"id\": \"2c9180887643764201766e9f6e121518\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
99
docs/api/beta/delete-account.api.mdx
Normal file
99
docs/api/beta/delete-account.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Account</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/accounts/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Account ID.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Async task details.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"id of the task","type":"string","example":"2c91808474683da6017468693c260195"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808474683da6017468693c260195\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
99
docs/api/beta/delete-campaign-template-schedule.api.mdx
Normal file
99
docs/api/beta/delete-campaign-template-schedule.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Deletes a Campaign Template's Schedule</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/campaign-templates/{id}/schedule"}></MethodEndpoint>
|
||||||
|
|
||||||
|
:::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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template whose schedule is being deleted.","example":"04bedce387bd47b2ae1f86eb0bb36dee"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
99
docs/api/beta/delete-campaign-template.api.mdx
Normal file
99
docs/api/beta/delete-campaign-template.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete a Campaign Template</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/campaign-templates/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
:::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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being deleted.","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
107
docs/api/beta/delete-campaigns.api.mdx
Normal file
107
docs/api/beta/delete-campaigns.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Deletes Campaigns</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/campaigns/delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
:::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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
The ids of the campaigns to delete.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The ids of the campaigns to delete","type":"array","items":{"type":"string"},"example":["2c9180887335cee10173490db1776c26","2c9180836a712436016a7125a90c0021"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returned if the request was successfully accepted into the system.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
96
docs/api/beta/delete-connector-rule.api.mdx
Normal file
96
docs/api/beta/delete-connector-rule.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete a Connector-Rule</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/connector-rules/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Deletes the connector rule specified by the given ID.
|
||||||
|
A token with ORG_ADMIN authority is required to call this API.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the connector rule to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
87
docs/api/beta/delete-custom-password-instructions.api.mdx
Normal file
87
docs/api/beta/delete-custom-password-instructions.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Custom Password Instructions by page ID</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/custom-password-instructions/{pageId}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"pageId","schema":{"type":"string","enum":["change-password:enter-password","change-password:finish","flow-selection:select","forget-username:user-email","mfa:enter-code","mfa:enter-kba","mfa:select","reset-password:enter-password","reset-password:enter-username","reset-password:finish","unlock-account:enter-username","unlock-account:finish"]},"required":true,"description":"The page ID of custom password instructions to delete.","example":"mfa:select"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"locale","schema":{"type":"string"},"description":"The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\"."}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
67
docs/api/beta/delete-form-definition.api.mdx
Normal file
67
docs/api/beta/delete-form-definition.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Deletes a form definition.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/form-definitions/{formDefinitionID}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Parameter `{formDefinitionID}` should match a form definition ID.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
Returns an empty body
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
object
|
||||||
|
|
||||||
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
An error with the request occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
An error with the authorization occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
An error with the user permissions occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
An error with the item not found
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too many requests
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"Internal Server Error\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
An internal server error occurred
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-identity-attribute.api.mdx
Normal file
95
docs/api/beta/delete-identity-attribute.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Identity Attribute</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/identity-attributes/{name}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"name","schema":{"type":"string"},"description":"The attribute's technical name.","required":true,"example":"displayName"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-identity-attributes-in-bulk.api.mdx
Normal file
95
docs/api/beta/delete-identity-attributes-in-bulk.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Bulk delete Identity Attributes</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/identity-attributes/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of identity attributes' technical names","type":"array","items":{"type":"string","example":"name"},"example":["name","displayName"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
101
docs/api/beta/delete-identity-profile.api.mdx
Normal file
101
docs/api/beta/delete-identity-profile.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete an Identity Profile</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/identity-profiles/{identity-profile-id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"identity-profile-id","schema":{"type":"string","format":"uuid"},"required":true,"description":"The Identity Profile ID.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returns a TaskResult object referencing the bulk delete job created.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task identifier","example":"ff8081814d977c21014da056804a0af3"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task name","example":"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task description","example":"Generic task for terminating data in the overlay, used by the TerminationService."}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User or process who launched the task","example":"support"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time of completion","example":"Mon Aug 21 14:57:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time when the task was launched","example":"Mon Aug 21 14:55:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} schema={{"type":"string","enum":["Success","Warning","Error","Terminated","TempError"],"description":"Task result status","example":"Success"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"ff8081814d977c21014da056804a0af3\",\n \"name\": \"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d\",\n \"description\": \"Generic task for terminating data in the overlay, used by the TerminationService.\",\n \"launcher\": \"support\",\n \"completed\": \"Mon Aug 21 14:57:39 CDT 2023\",\n \"launched\": \"Mon Aug 21 14:55:39 CDT 2023\",\n \"completionStatus\": \"Success\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
97
docs/api/beta/delete-identity-profiles.api.mdx
Normal file
97
docs/api/beta/delete-identity-profiles.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Identity Profiles</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/identity-profiles/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Identity Profile bulk delete request body.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
||||||
|
|
||||||
|
string
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
||||||
|
|
||||||
|
Accepted - Returns a TaskResult object referencing the bulk delete job created.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task identifier","example":"ff8081814d977c21014da056804a0af3"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task name","example":"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task description","example":"Generic task for terminating data in the overlay, used by the TerminationService."}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User or process who launched the task","example":"support"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time of completion","example":"Mon Aug 21 14:57:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time when the task was launched","example":"Mon Aug 21 14:55:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} schema={{"type":"string","enum":["Success","Warning","Error","Terminated","TempError"],"description":"Task result status","example":"Success"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"ff8081814d977c21014da056804a0af3\",\n \"name\": \"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d\",\n \"description\": \"Generic task for terminating data in the overlay, used by the TerminationService.\",\n \"launcher\": \"support\",\n \"completed\": \"Mon Aug 21 14:57:39 CDT 2023\",\n \"launched\": \"Mon Aug 21 14:55:39 CDT 2023\",\n \"completionStatus\": \"Success\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-identity.api.mdx
Normal file
95
docs/api/beta/delete-identity.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Deletes an identity.</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/identities/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The API returns successful response if the requested identity was deleted.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Identity Id","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"any additional context information of the http call result","example":"Identity cannot be deleted as it is owner of following resources"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>associationDetails</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
list of all the resource associations for the identity
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"associationType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"association type with the identity","example":"CAMPAIGN_OWNER"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>entities</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
the specific resource this identity has ownership on
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityEntity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"id of the resource to which the identity is associated","example":"031034e97f094a4096c1be53f75f6b91"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"name of the resource to which the identity is associated","example":"Gaston.800ddf9640a"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"type of the resource to which the identity is associated","example":"CAMPAIGN_CAMPAIGNER"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \"Identity cannot be deleted as it is owner of following resources\",\n \"associationDetails\": [\n {\n \"associationType\": \"CAMPAIGN_OWNER\",\n \"entities\": {\n \"id\": \"b660a232f05b4e04812ca974b3011e0f\",\n \"name\": \"Gaston.800ddf9640a\",\n \"type\": \"CAMPAIGN_CAMPAIGNER\"\n }\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"message\": \"Identity is the owner of following resources\",\n \"associationDetails\": {\n \"associationType\": \"CAMPAIGN_OWNER\",\n \"entities\": [\n {\n \"id\": \"b660a232f05b4e04812ca974b3011e0f\",\n \"name\": \"Gaston.800ddf9640a\",\n \"type\": \"CAMPAIGN_CAMPAIGNER\"\n }\n ]\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
84
docs/api/beta/delete-mfa-config.api.mdx
Normal file
84
docs/api/beta/delete-mfa-config.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete MFA method configuration</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/mfa/{method}/delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This API removes the configuration for the specified MFA method.
|
||||||
|
A token with ORG_ADMIN authority is required to call this API.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"method","schema":{"type":"string","example":"okta-verify"},"required":true,"description":"The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'."}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
||||||
|
|
||||||
|
MFA configuration of an MFA method.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"mfaMethod"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Mfa method name","example":"okta-verify"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If MFA method is enabled.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"host"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The server host name or IP address of the MFA provider.","example":"example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"accessKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The secret key for authenticating requests to the MFA provider.","example":"qw123Y3QlA5UqocYpdU3rEkzrK2D497y"}}></SchemaItem><SchemaItem collapsible={false} name={"identityAttribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider.","example":"email"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"mfaMethod\": \"okta-verify\",\n \"enabled\": true,\n \"host\": \"example.com\",\n \"accessKey\": \"qw123Y3QlA5UqocYpdU3rEkzrK2D497y\",\n \"identityAttribute\": \"email\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"mfaMethod\": \"okta-verify\",\n \"enabled\": true,\n \"host\": \"www.example.com\",\n \"accessKey\": \"d******Y\",\n \"identityAttribute\": \"email\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
96
docs/api/beta/delete-native-change-detection-config.api.mdx
Normal file
96
docs/api/beta/delete-native-change-detection-config.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Native Change Detection Configuration</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/sources/{sourceId}/native-change-detection-config"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The source id","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
89
docs/api/beta/delete-non-employee-record-in-bulk.api.mdx
Normal file
89
docs/api/beta/delete-non-employee-record-in-bulk.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Multiple Non-Employee Records</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/non-employee-records/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||||
|
|
||||||
|
Non-Employee bulk delete request body.
|
||||||
|
|
||||||
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"ids"} required={true} schemaName={"uuid[]"} qualifierMessage={undefined} schema={{"description":"List of non-employee ids.","type":"array","items":{"type":"string","format":"uuid"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/delete-non-employee-record.api.mdx
Normal file
83
docs/api/beta/delete-non-employee-record.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Non-Employee Record</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/non-employee-records/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This request will delete a non-employee record.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","description":"Non-Employee record id (UUID)","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-non-employee-request.api.mdx
Normal file
95
docs/api/beta/delete-non-employee-request.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Non-Employee Request</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/non-employee-requests/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This request will delete a non-employee request.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","description":"Non-Employee request id in the UUID format","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string","format":"uuid"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
84
docs/api/beta/delete-non-employee-schema-attribute.api.mdx
Normal file
84
docs/api/beta/delete-non-employee-schema-attribute.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Non-Employee Source's Schema Attribute</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This end-point deletes a specific schema attribute for a non-employee source.
|
||||||
|
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"attributeId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Schema Attribute Id (UUID)"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete all custom schema attributes</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/non-employee-sources/{sourceId}/schema-attributes"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This end-point deletes all custom schema attributes for a non-employee source.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"2c91808b6ef1d43e016efba0ce470904","description":"The Source id"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/delete-non-employee-source.api.mdx
Normal file
83
docs/api/beta/delete-non-employee-source.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Non-Employee Source</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/non-employee-sources/{sourceId}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This request will delete a non-employee source.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","description":"Source Id","required":true,"example":"2c91808b6ef1d43e016efba0ce470904","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/delete-notification-templates-in-bulk.api.mdx
Normal file
83
docs/api/beta/delete-notification-templates-in-bulk.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Bulk Delete Notification Templates</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"post"} path={"/notification-templates/bulk-delete"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`EMAIL`, `PHONE`, `SMS`]"} schema={{"type":"string","enum":["EMAIL","PHONE","SMS"],"example":"EMAIL"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-oauth-client.api.mdx
Normal file
95
docs/api/beta/delete-oauth-client.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete OAuth Client</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/oauth-clients/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This deletes an OAuth client.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The OAuth client id","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
83
docs/api/beta/delete-password-sync-group.api.mdx
Normal file
83
docs/api/beta/delete-password-sync-group.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Password Sync Group by ID</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/password-sync-groups/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This API deletes the specified password sync group. A token with ORG_ADMIN authority is required to call this API.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of password sync group to delete.","example":"6881f631-3bd5-4213-9c75-8e05cc3e35dd"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
95
docs/api/beta/delete-personal-access-token.api.mdx
Normal file
95
docs/api/beta/delete-personal-access-token.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Personal Access Token</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/personal-access-tokens/{id}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
This deletes a personal access token.
|
||||||
|
|
||||||
|
## Request
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The personal access token id","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
96
docs/api/beta/delete-provisioning-policy.api.mdx
Normal file
96
docs/api/beta/delete-provisioning-policy.api.mdx
Normal file
@@ -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";
|
||||||
|
|
||||||
|
<h1 className={"openapi__heading"}>Delete Provisioning Policy by UsageType</h1>
|
||||||
|
|
||||||
|
<MethodEndpoint method={"delete"} path={"/sources/{sourceId}/provisioning-policies/{usageType}"}></MethodEndpoint>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source ID.","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"usageType","required":true,"description":"The type of provisioning policy usage. \nIn IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. \nThese are the common usage types: \nCREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. \nUPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.\nENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. \nDISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. \nYou can use these four usage types for all your provisioning policy needs. ","example":"CREATE","schema":{"type":"string","nullable":false,"enum":["CREATE","UPDATE","ENABLE","DISABLE","DELETE","ASSIGN","UNASSIGN","CREATE_GROUP","UPDATE_GROUP","DELETE_GROUP","REGISTER","CREATE_IDENTITY","UPDATE_IDENTITY","EDIT_GROUP","UNLOCK","CHANGE_PASSWORD"],"example":"CREATE","description":"The type of provisioning policy usage. \nIn IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. \nThese are the common usage types: \nCREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. \nUPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source.\nENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. \nDISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. \nYou can use these four usage types for all your provisioning policy needs. ","title":"UsageType"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
||||||
|
|
||||||
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
||||||
|
|
||||||
|
</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||||
|
|
||||||
|
Client Error - Returned if the request body is invalid.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||||
|
|
||||||
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||||
|
|
||||||
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
||||||
|
|
||||||
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||||
|
|
||||||
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||||
|
|
||||||
|
Internal Server Error - Returned if there is an unexpected error.
|
||||||
|
|
||||||
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Generic localized reason for error
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||||
|
|
||||||
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||||
|
|
||||||
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user