LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/list-pending-approvals.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

149 lines
69 KiB
Plaintext
Raw Blame History

---
id: list-pending-approvals
sidebar_label: Pending Access Request Approvals List
hide_title: true
hide_table_of_contents: true
api: eJztPWtzIreyf0VFPiRLGczT2K66dYtg7JDYhgt49+Z4txwxozGTHWbIPNbL2fJ/v90taV4MGHt9k2wOVdkYBqnV6pe6Wy3Nl5K3FD4Pbc8dmKXTkmMH4Ui4pu3ed5dL3/vEnaB0UAr5fVA6vS11DUMEARuLPyIRhCxp8uGgZIrA8O0lggJA07kdMAC09Gw3ZL4II98NGGc4APMstpSDMK5BVNlECPa+5D24wq/Y5vsSg0H8FVtyny9EKHw2E473wCzPZzwK555v/5sQZ7ZreVXAMm6JuH4p2YgHwYDfXPgFvmro8CQw5mLBS6dfSuFqib8FoQ8YlR7zUxkAtr4IhBsesHAuGGAbiXhKnuus1mdDWGLjYCkM27KFyWwTINjhqvreZYyV2XB8cdc9uxpcsygAlJnBXfjnONANSPdgh3PG3VXcjQ3O5Mjb+sPIHrNEaEBfgiRSKNkuPfD8+wP2MBcu08RgMJ7rhQjH1NCvPbdSNAJNV05qxcoLUQZ4wCIQCoBt+wizAGUgt/jMF0sH6dwwTurHteP20bHRbpwYR7U6fDL4kXVSM+rNehMa+yBgti9AIi3AXDweFHPTsRd2WMrz64p/Zm60mIHEgKAB5yInBPQ8xTKYIUra7dsm644GbBJy1+S+yXqe4wiDBGoUC9KHH+ZhuAxODw9N8QnED5SlGnDbIbGuGt7i0DbdQ760DwMFp2LEcCqJQL4hgVh4viBp9RckudX1qaYI1WjXCqQUxhX3woeeEox81GzAg4Xt2otoUTqFfgv+WX4mKKawOFCBvj1uoqZnWYFYJ+eQHgPaQEGUHysCyZJUZfBDld0EEQjbKiXqJLxl4k4ZCb/k97bLQwH9fS+6nxMcxZhvhh1fwYyY/JuJb3iRu057MD3l0I9Ay+wQqAqEX3rLyJGkFKz8v5WpF3Kn0sPeZSTp0nMDweaCmyD+xAdsWKAOcw4QvcgxwawqzUAjZcV8A/qxspSJMnsQSKp7FyiGJgJ4ZrsG9qOFgEwfMBpQYTQRMhVz/gnMD9hGn4iD7e3FkhtgRmE2YHN8ARxbgOmEgdH+gKSAlYVRywTkv2jmZcSJsJV2l6iArQFtZbC+FQnC+RQI0czzHMHdUkpOpNXbJCuW7dAiVzDWzovaOcGIxSEKkIe0YGnyBSs3BEsqu81QNtw/mcbfyYkCZhWF5xtk9rl+ijIURMul54eAnl5xLQDlPeDPYIscMyBBll6O5wenCKFcts1y+ZSVxR8gi25ZPlPCLMxzz68WNVh4Jtk3+uUexNiBf/cC/sI/1TKz0sHSKv4An+apFe99qbSJ1wFO7nm8Thkj1C9eCQTSFCa2LgYTAP83FwKkQF4EJvLZbgJwigbFF0iAA5bwMMMp/bj0+AEpLc1ogLRt1Gr4J0u2S+XFKlc5cYTRABgerApgzKEXOF+ObZBpOPw9wK5f1tnGfZ8jx+1QLILUc2/2O1AD/VofqRfaEiFwXgtYnve+E8cP3LFqTirrjWarjcIghWwXaNgSZ5x2KbNg+TUCA6CK1lsF04QWldCGDvnB3qFnmh6FPXBwPSXMnCNZq3cqtU6lXp/Wj09b7dNmp1o7Of4XIhEz9DWx0ECZw4H/2HENoWNEqNGeNmqnjcZp47har7UIIWVdeq9EHArEKgroc0jUjkmkOk8JjXV0hIvey23pYty9nt51e73+ZAKPx/23w1/68XcXvMG14E+FiRo7hFxlZ3JxI088DbPKMiCpdRJqKCcCLZMj2CAVWahwJm21pcJnKZBDH/Hls2Q1BmjUTKI8TpEkoRA4eAVaWThl1OEYJf/7IIn61vQ43ED33eCeTYeSrilODc7619PB9FeMxhMCxE9hQrvYjqdmArTPx3MdWN1468ji4HWKFqxu1qwlQBeMRu2odby7oUkPTcEpDDuPwHUEQecmso2ZdrB0+IrsURaNd+AY2nzB4C9aWvCecswdANhxzNEUe1F0CuxxzhWX0wfmKeUjpYtB4OpT3WbEC6GtUsosp20XwHyJ3Gj5QJttP2ew1xUm0NNnI5ASrNYWwWoc7S5YP20Woq/Ab+xBUBUy+GO7T4scSdkjBYYDKSR1CtP1lxr8RkL/PGOj9eQ1DY2G+ecYmfwMCgzMyRY5aJ78SQZmIj1NYHPadgwli9ZcxGl6bUoLFQL9eg9vYGpvTAIpTLE122ZDtCHYqNXbZrNhHUO8wevt4/ruFLtO+X1FI3XRw4UJjkUguG/MmSTxWqTxpL1Kvm0dTtKRknlqwFT4DZEYn+lw5oACP+lth7ZBKG1SBS3c0k24G42H54PLPno7Q/pDwn3Zv4K/BaluZWY34Uww0rZBWQQUNyk9Y2EJX7hG1unoUXIkfDoiMNYaxhPLuztZzNUITEUsWbQpg29jzl7Br369c3+GmStkC/6q4b7MwZdbAEXEQVUegu9YPOcu9dP80qTb1WbuaAWLIii9Gis8dzSU2DNybRAJJtfSRMqKNL7VEY221ex0gHKiwcWxwUXrqF2bPS/ayy+QGwb93Zu7VdMTaBJT8q3E6iz0CoGnncq0aC198cn2InDCP9niAUJ/BSco8M12jJX3mrHXjL+pZqyl4hA6CFbo+SsNWGsE87VKaLYEJHIgVw/cN3+SvV6uJp5jygyW8K93osRZjgpc9WaW7y3Ywxz+t5Y8UcjmJfnc5+5HdmWTb+yKh1dCBDyEZ6HRddhbzwk5afLXWo0FuKkwvO0IPRz0zk07fi5pJskAWHedV0hfTdGI4AbP3Mat4B3mDwblpFI7rjSaaFDajdN2p9pUBkV32ciT7VTJ8ygGhxxK8NmSWsyH9mTJgsC+d5HcOoG1JQWabq7SUe/dMrvqXt90L+/G/e5kMri4RvfulHXdFMHkBhqFgTkIbA7EnAnh6n1PgzZBdTuYz2yVlb6QBx9hyaO440ByXe6ZgwkDI4a7X95CeK5gwgnE94HEsXszHV51p4Pe16IJy4JHnnAeT8KEux4g48cKBIgSWgcYunhSUGkDGKQq1SYzHiyWln0fyXKSKks48ERT0JcVbufhNnO0xGGKcc2SUtZYcGYKy8Zp/ICFCB40nEEXsG5uhXYW3+AGpO3JcAkztpqod/1Jr3sJlB1e/3XUjL0haAHiyx1JkBwlzwu2GhmfeVG4sdMBALakHbydiJB2Sy4cbwbzG4uFDZTx5c5YPwEw8hzbgCUhtXXjGRFOXuKR3b4JOA8O58JZHqopBIcSgzsIuEBRq/Nw4bwhck/6l+cgvm8H/Xd3Z/3L/sWrU13pWrAKMLTHkgNYMrF/IByrIpdPlEgAjygHye92GNHsAubYHzHVHLunMCTxCWRN1zRIbNUumap2Ue23ckmNhh1TCGV5FD9mI9Xac5/LCarTOXzw/I93aSoSK75LjVxZxkO8ISm4HSUYEiqaL18rC3x553uOkNLwXUKHSpAe5U1uMS60eUneZM3pLDDk8OtGMDn1hyfFEoo+bBK051acTLZPzeM865A95ePFwq8WQbAOsoogcULGatcXd37GAr23jFOwqXageOPIj4SyOQgIxBUVi5QFhNqMff5AlofJVorQ6RoGjDEI0YE78j1K96wtv125H0zrBSidKgIBPaKHGDypuas0jVRcxAdrO8Ci28EcWqt+UuNw6ZFgVyKsbhGH7mg0Hr7tn9F21c/93pQ+ng/H77rjM/icCU1SjTU7cxWQci7S7ViAOcdYbcdoQVfqoA5gpZzKAwJcC71DKrxjjufe42KhjZlaGQpKBzd5f2k/rlFTgWGtdkr//SuL+c0Se8ZZ6RcI08AiUaJqyMwmHM4HkDfmHCakfsBhJR1g+kHk4iKPX6sFUmVEvk8y/zwqbx5ElTmBVMXEhe+IGIXZKszSFvzl1A08863tyWW0hymDzwUZYVjtZPwlzb5wDVk3BVoH0DFLPBmesU8aDpBRGB+fTBYH4QY6aWWY3Oi9z/54PBxv2LKdyqqPEIJNoEoxIqlU+E3xfiqQIopk8L4O3o5T1m+zoBktCkX6HA9odZpm/UicVHiteVxpHRntyqxRB0Y0Wkei3rbMmWkWYRNPoocDjSkzvAE718UKOc0gVfGrC2KyPHr7TB4tQOf5vXg6EHc88Gx2lHrZNq56UWMwlD2wqezH3oi1OswBVYzoOc9FoOAg3xRyUAIe+va9XZi414J11j/v3lxOycj+z01/Mt1UDYAV2iaWwcjs0tx7IIzVBFA7wRmgla3KygpqGSbE3SDd0A7SPp4yUdBDjV7QIw06DrhiY2VIRWU/2FVRPQBvL8DIHWunZzzQK5VgZdxzWIaVS0XJsqqufFNlXdO0cZKwglNxYqAjGW6aslZKFsyGkS/IgURfENY328htLSWk3FSfcJlmCnoeysQ8td8F3q1DMqF1T/g++qlKWhSKij9Y2ULj5POdCdGIpFgUZmgvHOIZH3VmBnOzw0CnTKk2CyIBV7ezXaAR1iKlHac+YnMlkSnKFw8yFppZ4HViFRd5ELZrOJGJ+/HuKjet2OzfC1f4a+nT20TTYjXISn2KI5LSKMVyDPRRPIOWKpOZka9NRJHNfPyAq5pjAz2uRMhhUeFFRiDPdB7L1agg97qxprPrz+zQ5+BbfhSriiyXXXLbDygWX6nSWfGJQhv0QdAXSYInXZNwDfqplAx5Sr3SNcIUapI5TG3W5WaeIfeXZLcUXCqZRAKyBiH6/6WDzK90CkWlbK3O8UkDPlm1eud41jk2eYs3a21eJxH6lFtwi7YJ8oSN86Hr5lRZA1SXdPyWmR5MHnph8Sl/0uYvMZheFXE7V4EJYiPbvnTnPoFQuGEPP9+NhpeDXi4ln3q+Y8Y9NVB+i75m1etWg7cqHeOkVWnNrGaFN2ZmpdNqtI9rlmjOTLF7oj010Obt+B+xXBWdaWw9ktROm5aJZ8qnKtuOASl8xSVd7iL3NCuf5NE0TvKrjCoKC7f1YiOskIIYsB3zEOwDxjMYTmmL6xJKMrIiy3QPIU4sUWsZoU3SgONswzm39aVaYqnqtp2B/DZ8iLkbjXo/QX13yRefbToSsFNkkSuOL7T+KQIy7uAm1orOgkGQEQdLmPlA5x9W12p6pz+Rl/Qe/pbQsdcb3lxP73rD8bgv0wPw+fp8cIF5g3x5gHqgPJA7GUp2L+UvCAc/jUagZDrR0OtejbqDi/THOwA27Y/xSX88HZynGl/eTNQvw+triGOH47tJ76f+VTdXk3BQuoAQdnzdve717y7Gw5sRPErtuemPKdTjR7HzVrocnPd7v/Yu+3eTaXeKjUbdyeTdcBwbirggYnxDf1I2BL/cjHv4dNq9kP+/g5n0L4bjX+nr5BcYa6I9xtFwPE2+I6C3g2Gcj9Fs6Pamg7dyDoDHL3JqRR4m8k8dZNTCiywmSQarmK4TR0dM+T3pJQ+svs9BHiID3bVqKh0ABkRXhO5iJtNKMzgr2otsdzp1cWI2m7CwdZqzpjE7OrKOmifPKJVMD0I90sNcrdhP47Ty5g1j/7NYLBNjIjcpyXztDczewOwNzN7AvL6Becw1WUuYJU69MPVW1A4+fY5T8QlzHZMtFSgVFOJBRj3KMwq29276n+Kmb5SRVPruCTmipj2dr8u0zuX1S0ooW0VHvHoUtTNKULAKG6dOyKYzEjMP1gpKRqjsxvPPf21Y5UxaKXueuQMnzoHElXuf00a4TFMY0FFt7GBsQRuTEmQmE5RlFlCiWmc/cjO+4qGnJoNU9LnxEWANdpDBG1mYpbtg7lcnKguGFR3BZ0e1k0bLOmpx3jhu1Tvt2YnFwYCdtE+owFuldoosQnboC0z52IbMZNn/BoLgVihYbUSABt+m9ft87D4fu8/HxvlY/M3gUbCD3o0cMD8Vmlr8wyehlC+zzZykN7VFUj42dVatYnZpxZeH+/a6u9fdve7uqLv5H8fqYLv6lVyf+rrrc+Pq+5VgEmuuj6/LFrKXMElGHmCIrFykn99NQbE/Chfbi89LLGN5Rf9ILuXru+wxP9SlBXp/Ri/9CS8QQaKjnIHcXDolvBOMS4+xl9hcH+3c82c2CKhb4CJSxmDlRYwDyfzIdWm7PzhgpicC9/tQnW2OTzSF6sqsiqyr2nuSe09yvxrtV6N/zGq09yT3urvX3W9Td7d6kjFWpC3KTwqixYLjoTRKnsvfqeaZQYPkprpY5YhVeW8FgbHYxyplPYfSrFGf1a2OIVomb5lHzROrYRw1eLtT79RnrUanlF7rX1LzQ0WRwseCmYhOTISeZ2bTfxFVc6JZU+dWpN8MNK9i9Y/2HRsnBVUnnseusHZJeUhBxod0ExqhTYO2C2yr6+uxAWf3YBfd3AEXgIIVT4yu8UPlxVkAXH9V6Vp4rEFdDhjfn6NGicup0BLg3hedoeM23rRnoc8HEMiDvQfr/Ireaao48sWePBvjjC9xxqz/2RACFT323NtF+d0BIO+jjZhIBm9I9Mpoh7sgABAQSJsV+517/3zvn+/X+P0a/89Y4/f++V5397r7beruM/xz5Q1t9s+hwc7+ObSt1ljsS51T6dWf7aaTqigMSLzj+vzEBye/AkQJEbqnW86XPJzDl8PsVZrxkdTgUF3qD01lDCCxi3wHeulDsV+AacCsxypf2lV9TM/1HuhU7KdmgQmSV8dQna/vmZE8z4jX6cpBqkRq30ZplqaPBpCEV5Vtpfjw7Vb4+r6FlReBsSMwB1h2oiSLHmMhP4QV3weqcuORLp3OzRHmduM7j0/NR10LvGEeEsiGeRSRb+tY0J4BlrnpIfofkF3AfQBE/LoJ8CYtsll4wQ08+5BuM0EfXWK41jJZdzCua6whNMRmDfaj4D6d4satjh9+fjd9kxw7UXcqCzuk6wDYCMSILF98kRl2osUouRm/m9lYQU1jlgNEYeqi83RR2RhsOJEdOwkyG7mD40/cvswz/TZca/7erbAz25eXM8uLF9QU5RHG26WeF0/N66VIfKehVZRuEjS8+TmDhSTtrTxeg9ckEVno5RtArRcPLuFVUvAw3oInCDWPA1JC4ZHdDjM0116MRwZeBeFl8XjvvpO3u2S6MWnlWDCnu/0HzJh7XiD+m9HrVVBVbu8j0LQXo0UHICqkEZVGLYVSRQ5ZsSvgRBJ+l6AYrhQmeQ0C+TAenu42pdr+RpwFu/AbHaD4LTNnenwLay22ND3jGVeK53DGASs4YEXaiUDhL5cyFCzQbZyDLGwmAegl/CdLoBBN2UUJq9DyE/hD6oPLhwGoysO6y1P55TQxguoTox+wddwGzDT64PEGIb7SRcF6jO/5UsTS2YM8BdfxdTxYRnN0k/jG2StcWv9u88UZd5MkC15j9tpWeoMl+fvY3b/I4u0tzT/R0iivGMWNhlXhQ1rIpUe3nvIL6HIH+D/8SppK7jfH43H6jTNpMEuHhyjTpNPG3BaULFgKTlegHuhbffC6D3UmVb3/6p6uPvQZXVE0sx28AoO9w/MaBpAYIzEsrwCov3sqJJsAlUf0yrEzzTiGt7JFLl4sDEhEC7wB4inumnZgRNIIQWDmCj0zeatT3EtrJIoNkoJq+oW/CIYWZpUhYE0x8YmxgIeBSilzeZ+wegNIMpGxkIXO2C7roj8FGySngtfzYCwIFhScKZEa4WowXYOIF2gFMC+IuT3//lB1Cg6xLdbpw+SlMDSrEAHS9Z1eEELgmoIbvx1jw1vjGB0dWrsoOM6q/yUvkVOLCUYBh0tMdOHcIhm5yJDxtrQpZMSoUgWNEGLMPTwYdVv68gUzIxhBPeJj+YIXDE2AO6gAZvE1K2lC7F9B9xqvoCtk7UeBOZDUewFVokO+kmd3Fn1bb53bQgr9Ur0X0uE/63Vx20RKv07vhYTcv/vt23v32xZx0C/4e6E07N/X9v/2vrYtTEvetPdCtv1nv19tC2WT99ollP2QpIwpTQsuFNkycpZkN7mrlOq1VneBUOJM/0UfvNXH/wO+hNgo
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Pending Access Request Approvals List' (list-pending-approvals)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Pending Access Request Approvals List</h1>
<MethodEndpoint method={"get"} path={"/access-request-approvals/pending"}></MethodEndpoint>
This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info.
## Request
<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":"owner-id","schema":{"type":"string"},"description":"If present, the value returns only pending approvals for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used.\n * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value.","example":"2c91808568c529c60168cca6f90c1313","required":false}}></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><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**requestedFor.id**: *eq, in*\n\n**modified**: *gt, lt, ge, le, eq, in*","example":"id eq \"2c91808568c529c60168cca6f90c1313\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**","example":"modified"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of Pending Approvals.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={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 approval id.","example":"id12345"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the approval.","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the approval was created.","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the approval was modified last time.","example":"2018-07-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"requestCreated"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the access-request was created.","example":"2017-07-11T18:45:35.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"requestType"} required={false} schemaName={"AccessRequestType"} qualifierMessage={"**Possible values:** [`GRANT_ACCESS`, `REVOKE_ACCESS`, `null`]"} schema={{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS",null],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS","nullable":true,"title":"AccessRequestType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requester</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Access item requester's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Access item requester's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item requester's identity ID.","example":"2c7180a46faadee4016fb4e018c20648"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item owner's human-readable display name.","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"}>requestedFor</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
**Possible values:** `>= 1`, `<= 10`
</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Identities access was requested for.
</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:** [`IDENTITY`]"} schema={{"type":"string","description":"DTO type of identity the access item is requested for.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of identity the access item is requested for.","example":"2c4180a46faadee4016fb4e018c20626"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity the access item is requested for.","example":"Robert Robinson"}}></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"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Access item owner's identity.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Access item owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item owner's human-readable display name.","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"}>requestedObject</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The requested access item.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the object.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the object.","example":"Applied Research Access"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the object.","example":"Access to research information, lab results, and schematics"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of the object.","example":"ROLE"}}></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"}>requesterComment</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The requester's comment.
</div><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={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><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Author of the comment
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the object","example":"2c9180847e25f377017e2ae8cae4650b"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the object","example":"john.doe"}}></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"}>previousReviewersComments</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The history of the previous reviewers comments.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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={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><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Author of the comment
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the object","example":"2c9180847e25f377017e2ae8cae4650b"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the object","example":"john.doe"}}></SchemaItem></div></details></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"}>forwardHistory</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The history of approval forward action.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"oldApproverName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of approver from whom the approval was forwarded.","example":"Frank Mir"}}></SchemaItem><SchemaItem collapsible={false} name={"newApproverName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of approver to whom the approval was forwarded.","example":"Al Volta"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Comment made while forwarding.","example":"Forwarding from Frank to Al"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Time at which approval was forwarded.","example":"2019-08-23T18:52:57.398Z"}}></SchemaItem><SchemaItem collapsible={false} name={"forwarderName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Display name of forwarder who forwarded the approval.","example":"William Wilson"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignmentType"} required={false} schemaName={"ReassignmentType"} qualifierMessage={"**Possible values:** [`MANUAL_REASSIGNMENT`, `AUTOMATIC_REASSIGNMENT`, `AUTO_ESCALATION`, `SELF_REVIEW_DELEGATION`]"} schema={{"description":"The approval reassignment type. \n* MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. \n* AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time.\n* AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html).\n* SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval).","example":"AUTOMATIC_REASSIGNMENT","type":"string","enum":["MANUAL_REASSIGNMENT","AUTOMATIC_REASSIGNMENT","AUTO_ESCALATION","SELF_REVIEW_DELEGATION"],"title":"ReassignmentType"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"commentRequiredWhenRejected"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"When true the rejector has to provide comments when rejecting","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"actionInProcess"} required={false} schemaName={"PendingApprovalAction"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `FORWARDED`]"} schema={{"description":"Action that is performed on this approval, and system has not finished performing that action yet.","type":"string","enum":["APPROVED","REJECTED","FORWARDED"],"example":"APPROVED","title":"PendingApprovalAction"}}></SchemaItem><SchemaItem collapsible={false} name={"removeDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"removeDateUpdateRequested"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"If true, then the request is to change the remove date or sunset date.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"currentRemoveDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The remove date or sunset date that was assigned at the time of the request.","format":"date-time","example":"2020-07-11T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sodViolationContext</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
An object referencing a completed SOD violation check
</div><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `ERROR`, `null`]"} schema={{"type":"string","enum":["SUCCESS","ERROR",null],"description":"The status of SOD violation check","example":"SUCCESS","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"uuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd","nullable":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"}>violationCheckResult</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The inner object representing the completed SOD Violation check
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>message</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If the request failed, this includes any error message that was generated.
</div><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></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"}>clientMetadata</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. 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={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></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"}>violationContexts</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"}}><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"}>policy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
SOD policy.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOD_POLICY`]"} schema={{"type":"string","description":"SOD policy DTO type.","enum":["SOD_POLICY"],"example":"SOD_POLICY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy display name.","example":"Business SOD Policy"}}></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"}>conflictingAccessCriteria</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The object which contains the left and right hand side of the entitlements that got violated according to the policy.
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>leftCriteria</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"}>criteriaList</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={"existing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":true,"description":"If the entitlement already belonged to the user or not."}}></SchemaItem><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={{"example":"ENTITLEMENT","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","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.","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}></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"}>rightCriteria</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"}>criteriaList</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={"existing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":true,"description":"If the entitlement already belonged to the user or not."}}></SchemaItem><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={{"example":"ENTITLEMENT","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","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.","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}></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><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"}>violatedPolicies</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"}}>
A list of the SOD policies that were violated.
</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:** [`SOD_POLICY`]"} schema={{"type":"string","description":"SOD policy DTO type.","enum":["SOD_POLICY"],"example":"SOD_POLICY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy ID.","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"SOD policy display name.","example":"Business SOD Policy"}}></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><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\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-07-25T20:22:28.104Z\",\n \"requestCreated\": \"2017-07-11T18:45:35.098Z\",\n \"requestType\": \"GRANT_ACCESS\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20648\",\n \"name\": \"William Wilson\"\n },\n \"requestedFor\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c4180a46faadee4016fb4e018c20626\",\n \"name\": \"Robert Robinson\"\n }\n ],\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"requestedObject\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"description\": \"Access to research information, lab results, and schematics\",\n \"type\": \"ROLE\"\n },\n \"requesterComment\": {\n \"comment\": \"This is a comment.\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180847e25f377017e2ae8cae4650b\",\n \"name\": \"john.doe\"\n }\n },\n \"previousReviewersComments\": [\n {\n \"comment\": \"This is a comment.\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"author\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180847e25f377017e2ae8cae4650b\",\n \"name\": \"john.doe\"\n }\n }\n ],\n \"forwardHistory\": [\n {\n \"oldApproverName\": \"Frank Mir\",\n \"newApproverName\": \"Al Volta\",\n \"comment\": \"Forwarding from Frank to Al\",\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"forwarderName\": \"William Wilson\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n }\n ],\n \"commentRequiredWhenRejected\": true,\n \"actionInProcess\": \"APPROVED\",\n \"removeDate\": \"2020-07-11T00:00:00Z\",\n \"removeDateUpdateRequested\": true,\n \"currentRemoveDate\": \"2020-07-11T00:00:00Z\",\n \"sodViolationContext\": {\n \"state\": \"SUCCESS\",\n \"uuid\": \"f73d16e9-a038-46c5-b217-1246e15fdbdd\",\n \"violationCheckResult\": {\n \"message\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An error has occurred during the SOD violation check\"\n }\n ],\n \"clientMetadata\": {\n \"requestedAppName\": \"test-app\",\n \"requestedAppId\": \"2c91808f7892918f0178b78da4a305a1\"\n },\n \"violationContexts\": [\n {\n \"policy\": {\n \"type\": \"SOD_POLICY\",\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"Business SOD Policy\"\n },\n \"conflictingAccessCriteria\": {\n \"leftCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": true,\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c918085771e9d3301773b3cb66f6398\",\n \"name\": \"My HR Entitlement\"\n }\n ]\n },\n \"rightCriteria\": {\n \"criteriaList\": [\n {\n \"existing\": true,\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c918085771e9d3301773b3cb66f6398\",\n \"name\": \"My HR Entitlement\"\n }\n ]\n }\n }\n }\n ],\n \"violatedPolicies\": [\n {\n \"type\": \"SOD_POLICY\",\n \"id\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"name\": \"Business SOD Policy\"\n }\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"}><p> An example of a 403 response object</p><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"}><p> An example of a 500 response object</p><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>
Reference in New Issue View Git Blame Copy Permalink