mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
186 lines
92 KiB
Plaintext
186 lines
92 KiB
Plaintext
---
|
|
id: list-access-request-status
|
|
sidebar_label: Access Request Status
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztfWtz4kbW8F/pIh+SoRAGjI3tL08RjCdkbeMX8Ex2Z1LeRmpAGSERXezxMzX//T3ndLfUEgJjj3PZfajKBCOk7nO/9enWl0qwEiGP3cAfOJWziudGcde2RRSNxO+JiOJxzOMkqtQqkbCT0I0fK2cfvlRuIxH2Aj8Wn+NuEi/gWsV1/DNOT1qhfNSK6NmzUHCn8uvXX2uVmM8jvFfOwNQUUQV+ckRkh+4KAQEwJgvB8jcxCQjr3gxYKOIk9CPGGYLLghmTEzM1MZMTi4hNeSQcFvgshgGjlbDdmQsX4K7wka14yJciFmFU/+h3/UcWB5+Ezx7ceME4fOWAWYAoM5v76dgwkhuy4MFXs9RZ13xwOHp71z2/Glwbj7sSMjeEqeMARvM8GMaVyMCFuYgNXFLgZwHMA9OFDL4CkMCEDGRig4u0ImTgNx9+ga8KTuFY8DzyzV6IJa+cfanEjyu8IYpD159XvtYq4jNfrjy81rJPmyeNk05n2poeC95uNOEv+6h9NDvtNNut00qRQReuB1AQWUMRJV4MtH6kr64j/BixRvAfFq69UHdJXrMHEQq25I6os+pSVJnrO67NY8AXbwMZC+F5wrjOrpI4AWI9MvHZ9pLIvReSyNVQzHnoABqWnq6K5NFUrpzNuBeJr7WnSDR9/CspFC94TKTIUeivpEvx6b+AOpmWpnSSUgT6IlxSB4Na8A3ELOYh6hAoz+sR0tCiKpgDx7w2fRZZeRS5cx8ei4O/GT3xd7BkSERJuoG+RVvd90H4iQ1isXyamLsTxA4SP15DYTBj1ThMcJIYuAA2chWsEg8mo7mqv1iTIOae1cOnq4jmKvAjwRbgXgAD4hve6CfLqcRIU4L07CFIPIdNhfIeSA+Y0HOXbqz4G8xmkYAvZKGAYwFgUoJVCQunQeAJ7hNKMw5zpgTIeLqVIgTGGkWu+OcybAKFwm6wueCl5wI9AUjyksfy0mELLixd310my8pZA/7mn+XfraOGgQZ8M5FoNhqbUJDUW8NhSJdBbgBs5M4sAcZKVBj8UGe3kdTATE6lBirOwGMrPnd9KQZhkMwXppTX2bkElejSQJ76QZwN9oo0ytNhExlmpIjRrooOgQuKc9eO3XvQO9S0gcPE7+yjtgHHnU7TPjl2ZmADOmAIxMx2Zkdtu/GxsskKaEkBg+bPpRGIQcLBtrPo0Y9BquRjU1QCn314d0iRyFjf1As8T9g4JrtJA45ff1jE8So6OzhwxL3wMGysR9z1VgGQqm4HywOIAA/4yj3Qk1l2Oo6VBS7fSQqhl1Fwvvnof/Qv9FW0S1GyWgUhWFoKIkhsYKjgAX8GrnpORBorQ9cgjM5whGq1lJjV6hmrit9rgGkNIi34F9eYB58efPrw6UY+yGSNRQ/V3U1YhOBtZbMhS0CcJbcigUQApFAC8nwbw2h/c64hwkWejeW13TgGXKjakArAPTW2DBxSzxor5RkwBuatIj8yVVEPl/DoV7wkvUGEjGg1GviRp/GlCq9TLw5uRix1EA+j2pjPgF+CJ/lq5aGbgycPfovw8S/rfOZhyFEicJjIuB5MfwPyYbAeIrljVwIlBWddSvJQ/pQsuW9hxsSnnmCOG608/kjk0D6awJ4KpGyKSz1HKZk53YQBqJpootCCgON4lTN0sCB+Eoh1YISPpg4StF6vPx7f3YyGF4PLPvwwGtJH/3oymFz2r+CzUsNR1zM3GDFPZkmPAoTF8dcghJTLFiCIjopEzkUMYkuUBHcxnFH+s53iqHaKoduJ3pM3ylBchU0yLHpYQF6nQNFaCeFcYLsoihrJPG6ThZtlossE/gdBR4pOHbWfBi8TmYLvxNu+j9LArb6G4iY+lo9zPhkyvLNucHpwTjz9J+bgGQ7pVQDWdXafIQ0xB+d5okhnxtvHMw5EFuDHjmfTtmg0T+xW4/jwFCfaTUP0VKZq5OcaS1tU+YqC7sZ0jZ46hwAcrmnjs9VmO8BgK3YBoiIA5xiKKNliDxxckeOALHyz3LQazVOr2bJajUnj9KzZOWu26s3T1r8IjzwIoNr3QGqa2sVr3APnQApC9pcb1QoIfRcA5FRkEEl7oUnT26Bp6PoKavkrxi5hGIRXYF/43JTB1BzmH1k3j880m15gc28HscCKkbw39UBLCSTDKhU4GvZj74a1O8zj/jyh63ye54DwrdtxmTGSAw9Dd+7628zmef+ie3s5QXvZ/3+3/fEmI9n1dSIVUGi/CB4IYoUAClUk0AkDp1hVjVoFhLgfmTeqFC56jNAnqKAdnlCzlzxhDs1mYbA0M2Zmy5Ie+8Gti3oNZAYtGI8hWcwV0qroYFaxdakoWVU52Js662YCec89GBSef0QDKJXE9VUSAPmLTLWDJMaI3bULSpyRsihQWm4vTaagqgPkT8sJBBqQb5BMaIdKEp1KiwJRJ7qOolzRxmdEI5JigAYhjE2pjB1AWmyD3QfcXIjoVGRBcRLEEL6+z/WBRi66BMNS9Q39UgZrw08Y0azHkjrO0eVEAt/9X0Akh2dUw1yJ+481JnwKwQSWJ50kTO3VCjQRADzADzeC0fEX+ILBBbkxjJ22hhH9X/q928ng+m2mEXe94dXNZX/SP4drve51r395SX9P+qOrwXVX/gCBwbvBeDC8hmfv3vVHg4tBrzuB73c3/etzPeDP/V7J7RfdgRzxeji5615e3g0m/SuKNeQ99Ft/NBqO1uvOg1x5g/Cj8rJfqDBDwlFlKXZnzJQHrFN9FnaCoXFN11ry40p9hRudAGkaBRDdKcLC9zoOvkauM5YHTk9nWPcApRNtBg6Q0jYPHUpr6gZkqu0HVMABIFdJTM9mvMg/nE4FwrKknBwrKmBvBdVs0Bdi1Io1bgULDfckN9dnmUHaHS1geCrEK0kEhoiVTP1yMgmEfOAupSIwNRibe8gkKfuXlJRysk6HUPwmbewakFKGSsACz6iK+CaCGyXtjA19gRXKJdIoX59UGUjZoDUyHVjrFLIaFRijQK5Fsigimpsk+YyBS5H6HdhUlUtVWYNvyFfOlJk6qg3NSEOI6ZhceDGWgwTqvuaJEZe/zMGD9DxA2pkLxzbV09acPjgENGOmPkjvDyJBeRKyOZ1BOjyiJUVpQHHu0wpLjiS6dBeQa+HecLdoPa2dApuDkJ7MJJcmfGn8ruN2ObJbNnQhS9AG+O0Q1O0aLcHd29Hw9gZ+ep2Af3D+DGCMLKCzJQtot3bPAs4LifEGSPLTX4Ep5sJj6hNCXHS8qoidcnlzermB3w8LrMjeu+IBtRg9p/QVJIBGqP+trHefO+Hr5niS5c8HwuD+YWcz94+ewf0nqiTfAGMX3KLPut4UGIWFHzMyk2UVNIkjNeaPj5uypG/MMSdwkeGihYwetCXTo5Ykjo0Tq3U4aZ6cHbXOjjr1w9OTf5VlMrLctS1mywKs7g16MgqXjFir/8vNYLQWvXVHvZ8GeO+uIZVpsjPXlLfeFGWVhgh5Iw+fXAcAhTBK47Dt8TSqkbZja9iw7l1yQYQizrZnxOcVNQLo0IvLkm3MPwl/W+C2PvOGME4OKLFXXNkN+9BeuPcYcs1wEUHFIjhUTtoy+dB6ccV9SKlwpVCHCxQhUMF0e5Xx5uZu+P66P4Jr4+HtCLyU/nrVve6+pb+w8pheztcN08tGWTK9tub61iTzXJXTozThu3cdTA6BPvMwSFayekLVPKouu1NVXeB+PiYtuJkU9tRyqJvHkiQ7VFH21ZF9dWRfHdmpOrLWRZDLBii3wsU/20uoYgr5ZL4QotoDMM2aC1/QEl29dEnimesJWYVlJeu1aZFYOZpCeDrQ16V1ViiUQRKKJdx2vqH6sq76jm6iCCGvQvOm4qCVXCJC0oP38AJ/jv5DtaswtWK/3kBS3xTEmDFJq2E1OlazOWk0zui/knjka4mJpACllLX6llypW3AVIFFFaplzRZtz06eK1P8xuaoSiCdT1SLC21JXlUk9YOsPAUYQ1DTw2fU0dEihftUMtwDAX5ziPgHNn5njFkB5SZK7eylD93iVTFoUqm/l/Iap/hrG7wjMH5DdFvm+hQPbEte/Sxa6zzr3Weefl3UqV/STG0H28Ph6rj/wnK6K2q5fpMU65pOO/WGhkos0j8x5/zzyFyH3P4FBD8mGiIdXAgRCimeB0fXYu8CLeWV7LLw91Mj12oBhkRnpg+w7L6CdXpc0k2QAqLveK7Rx5I3bLvhvs3D6kY082U6VIo/S4aiEmQWFJqvywL13Pc/lSwafZP4xSZCRPJJ7onzxemqQIm7eLruEGCrzVff6tnt5N+p3x+PB22sssdBiU0Yw2XdNCUthhEzLVQ4hEzt9XzEfwsSTR5/Aw6qAU2fgbog7dhJaWMS1UoyKIbIR30cSxu7tZHjVnQx63womT+IA5GYdToJExd+pAgGgBJZsYpSCSjkTSJVxT24+SHZn7jyRO67qbGIkg1tv1YUC7KXGwlSwAdY8KXU3EGQmLqLxA3xbBREWsh6xe9a3hA9i9YaBoXMDhzwkqEVdE/WuP+51L2mp9q+jZupC4A4QX+5JghQoeaGXR11fKj/ew6dYQNn0UA0Gnkk7+GEsYnLkb71gCviNxNIFyoRysbmfDXATeK4NLsHoqw3sBJGXcOR7ayPOo4OF8FYHek/KgYTgTiwxM60v4qX3hsg97l9egPi+G/Tf3533L/tvX53qej+ILIdhX30o7vH5SHgzSy6ToETC8AhylP3uxglhFzHP/SSy7jKgnexDRVnTAYGEVjWRqJ1yeqllG5fUbNQPkQGU51F6md2ouwP/uZygvXQHGEvfmVQkVnxnzGyt0inekBR8uMkgJFA0X75VFvjqDusyUhq+y+hgReYsbwrOuNTmVWobI+wSQ44R9KZhCuqPFfpSCcXQO2sbKHicsgLPRT5AW6vyoElcyB+zaAWEXzlBHWjmxr4qLfusDS1vy/IoCGZlTzmZyVxLiW60pqpSaY/6DnkkGVSj7VONQyjc08ZQmmG9T/a0dWxPZ1PHcSCLhL/sjn04bTYazYZ07CQ/kw35dZofj7rXkzu5YkLJ1LvhP/rp9/LKe34brYwCzA025ph1lhtSmiHcKRv4YHgW/B4tBaZEnrGvDHJrVUJOu2DQJtAWgTwlCuBvqnPnNitLofvm0PA9du/GhSK2x7Hcv2Pqe1pvHrdKF2D1LoZXhEwNuQ2mduPs8Kje6bT+ZQjQLpWg7vqC+au0pG8a949rUX8Kk5KW9a2FvJPdCzrm1LqItNjcwrA9sN/QkKA5arAXNaskAS4t9bm4NCLBlOUF3aIGQlnfth65oXBYbLZwS8Z8tX6YXSb7Q3thdgLAEKz2FsFqHb9+H8zz4BsFWERk8OH6T4scSdlX2ig5kELSpN2k+kvDNDi9rGzwCrt4dqs0qPXFkk06WMHTOznI0X+bcaaNIRgp4q+5HSKbLHRHLZGhhT46O+zUG6qcIM+OKNM3ZPYQHGw5zl16Tlc6Nel2VbUddaQsYksXbyScO6oRPpn4LggHkxpFO2g0qmvb4dsd0TqaHXY6QDnR4uLE5qJ9fNSY7q4xtBpasqmuZNLfgoVfdwKMYk0NUGIlVyiLvV9l05nOJhM2bBKLAuedG8jMUp2mkteMtb4ICabMiYRvY6TKs75vNh6es3s9IrMXwv6UZQQb9OvJJv7xrY7BZNP8hn1/qsyeREjSckCMLVq35XEdECVJpOSsD+86mlvv8kMzypjKcp90wlnn0Gkei1OLNw5PrPaxfWRNW6B/zVb7WDSPZg4E22XQpEj0cKIRbX7dAJ1P5yhoBkEaF6lkUamiwaN3z+SRalXY9wPt+4H2/UBb+4F2bAeSC1Ebe4JUSxCAmusISjH6kGlaqgZ5qTc4IildSTdoYKWuuEkDYSyzmeQmbM8FelyJGMK8mJcZgSLTs22hNyWO3ziIosDtcOrGIQ8f2SfxaJFEshV3w4gK1Y/yUBZf3FPdT695ZpVFHfxfg34qJUOe0lPmuSuBbyzzabEqYJ4j95cspemuVnKFBcgaxVgcq9Ryv9IpZipemHVOTlvwFx6dcTLtnDi8zQ8bR7xJInRfcL3P6hNaN6fKGqC6mMXNHHqAPDyF51zwJ23+CivNj0+nXCg28t6X5lTZCKXpN/x8dzO8HPQK8aBxfcdwz5iomGw3Zs3mrMXbVsc+bVvt6ezQ4q2pY3XaraOTxkwcTh2xe5RnTLQ5sf4RD9rAlAjvvpHUNk3LOHDkVdWMhtVa+IouXWZBPc3KJ3k0SSNMtdyIwsJd7WzELKa8AWzHAveZwZ8R5G6pxfUJJAwcVbPiPIgziVpbLtkkDTjPNpgLeZe6k3aZbmlQLvZUy9Y8BXo/A313yRefYUpk6y5NdrlOuA3W3yAg4x5mUOhkqd0x7XKkJgawzuBdKRXUqmNslDPPvth2csbw9hr3bY5GfVk7h7+vLwbU21I89kJd0Js9Zd9I91L+guPIhphLtV+S2l+ubrqDt+afdzDYhPrNe/3RJN1cid8vb8fql+H1db83GY7uxr2f+lfdSuEsj63dVNmfBujppTR4q1wOLvq9f/Yu+3fjSXeCN910x+P3w1FqKNKDREa39GHYEL0FAP6YdN/K/98BJv23w9E/6ev4HzDXWEeMN8PRJPuOA70bDNPFCs2Gbm8yeCdxADj+sWEnAPpm4J86CFMLL7KYJBmsonnCDQZiKu4xXR5Y/ZCDPCQ2hmvmCQtgQHRlehczaSrN4LwsET7qdJri1Dk8xDOhDqeH9vT4eHZ8ePqMmqQ5CT2R6yF8ZD+NTOUtGsb+Z7FcZcZEZshkvvYGZm9g9gZmb2Be38B8LdyyVjrLgnrh6D6NHWL6AqfSgzN0TrZSQxn7RPQsz1gZ2Yfpf0qYvlFGjPLdE3JEt/Z0vW7HIq+Td0u5XD5Ka2xmL0DaxUc5vtl88IKjzgLsFRTOOJneLHgkRqo+XJb1r52nJR9lvfE7On06mbIVjpEWmQWt/MuJlRKo9GVzK0+GjOz5UexUhRdsEtBDfCzfs/OxUjg5RU4sj8SAIWZJSN1j5uRkMuEmlWmlDceETl6oyvcJPe+grXVcsymNveVa0m5KOLxh8/gqFLpbZgJB1VyEf8bpd5SGakkFENLOI8DYJshzJNSL2hFT7ciOXHumnfHh09PKoqC8W6vN07P+HCx8dh4IWbxSN2zfYry2m6B07UIPVgpKLLmQx1+P/BKp2TTDExK0SSw2yBE3e2PIMHzDVuMo5uGGtdGS5UBcAVUaqzWQqRFeunsQu6zVqUDfAIQe4jlQtLbtYXzOymO24lhulnR4fnfzU3fc3+mIrWxjhHmQz6ZDtvCgInnfJj0wtsqUw5gNTequF8SeWD28uMWcQx/NtXUFcevsueHWOLHKOb8dljcyJ2dssNQORK3flByGlPOCkXSDJQpO4LPrQHsvbVxNVyDvUo5Rl8ox9n1U+y1haA7//IAti+2LedIUT2Qq2237fDvlRsWXa6RcKW3BU2ZmfW0hjavlHak/L77nA5dH5tjhr0/7BrdO4U0NWYQNtAgjnT8m0s1dSRp5GXZzTTxyED3ZaZR9M+O2fEv6huNtdXeJrFDMAVJ5tDVtvybEhboaEXPnIfc37Trfvte71IRtD1ezHkKEhqduHM/rcBJPdcPStMVNJvKI0gY2FWqLWG8o2yz3hclpX2VzNEaJ6cm5hQU4RZucg9ulJddkzHo3brFBZ3pyeOKIU8uZnk4tPrVnljhuH1tOe9bqtLnTbh1SPry+Pre2CFvwrK+9PqdPGlCvLpDrmun6MS2w4gEmtEiQ12YT4S8VGLYJ89DIeG40fG/p7618clViFSsqR2+XHb/dIyIxWq9lFmh79hIGk+nTwKH35aSLvc8/l3tD/CINWy9wdvALF6CbFiglbZqRq7Y2PKjOcUAqGiY/tzCelyCgRL3JfuROat16ChmkZMjtTzDWLnJ7K5uk9CPYCqOdScm0oiP49Lhx2mrPjtuct07azc7R9HTGDw8bp0endNiyPv3iyQbRt7gC7trGOaK4bSLw5ekLOPnuMeS+PWXfnvJ/uj2FjmLgSXkiVgjOPDA/FqGW/nAvlPJFcv8WhW/r0ZsOUujh9OwZRYv02Bvac7HX3b3u7nV3R90t/jhSLx1Rv1Lo01wPfW599SpAdJ5roU+oj1/SN8lipmRkDVcMVYj08/uJetEgnTBN5zm8YnwkXfka8N2UH/L6VLeraddv1OYAQKKjxED22p0R3BnEla9plHi4PttFACEuCKhfEiLSAupjkFDGFCY+Zc8cYl8nEJH/fay2nMnwliwgzuo7ltyDuY8k95Hk3hvtvdF/jTfaR5J73d3r7n+m7m6NJFOoSFtUnBQlyyXHA62ol0j+TscLMLghexlqqnLEqmK0goOxNMaq5COHyrTVnDZnHVu0Hd52jg9PZy37uMWPOs1Oc9pudSqmr3/JFgha4REh7h9I6HSVOAicfPkvoc1t9PrrOAuJ8SwGapTQsWPrtKQJPwjYFRZB9WvFczGkn9EIbVpAyymP6buC8QbO5mAX/cJhODAKbgBh9D5SVN4JrQnF4aPVpSPL1Ptn02MN1Czp7hK0BNgKSOdtcTfWb0yBESiCnYN1fsXo1Ngr9uJIno0Q40vEmPU/20KgoqeR+1FZfXeALxBCGzGWDN5Q6JXZDvdBACAhkDYrjTv38fk+Pt/7+L2P/+/w8fv4fK+7e939z9TdZ8TnKhraHJ/DDTvH50fYUMHSWOqCWib+7DCdVEVBQOKdblfOYnCKK0CUEKC5IBvC4wV8OZAFWEuxylJHP9cqMvCXICWhB7fqU/O+AKeAQ1/rfOXW9Zk1fvBAx+ZNgTxb2zjwBnoRupygTrQNXRRfaetocElp1YJSSU/m2zqy7tZ7DBKwbjRMDdvulSjRZdzIDHnE95HqXEfKrOEHeN2G3tdvx0UOtAGXMvJtb4BZuQwgLaCIKPyK7AKWw0DylTU0+22EB/iQucJzZkxHgolaa22yId7WYj8KHtIRjrh28cPP7ydvsm316m33wqXGO85uQETIlHV1HR8fIu8iu8GoYyy3UoKqw2YeIMw++mMh2Adz08wIjDKRFB8SZAfwKePMRnEvPHR/hfMaXcc/AAod8Nxzb8jVFfve6x99i527aIHSfn+Fojyi5cNK48UNvF4KxHd6NEspG40WvSlAIUn7QbYn4RlERBaOL84Aar14cjmeZYxnUf+ahaMWYUBKKDjy61u25tqL4ciNZ+F4eTg++u/l0c65x5g0WywCN+g5bMDsRRBE4n8YQ9FBNfgwT0CLXgwWbVuwSCOsVsMAyZJTWq4FUSHBdwmKoTZRyHZLCkoC7FF2pEr+mzgLOv9v2iD+7xzOdPkDtkfCnU5gRy+GGSe0cEJL2oBIwa+aQQFYbDUEHOTOAhKAXsZ/sgQKUMPuybFKrToNf0DPoGuwAVTZZL46k1/OMgOn/mL0A96d3gNmGIPqdMUPvjM11tf0EC1FLF0OKFJwHV4vAL9YoJuENy1Hoa/8u+GLGHezqgmeEfbaVnqDJfn72N2/yOLtLc1/o6VRYS6KG02r8gFTyH9U8dp6FS+i3nT4P/xKukoRNccDQOQh3vmtvSuPxyjVpNX2whWU/68EjzH2q+lDvYWTnroTyYHmdLJgyOiE8qnr4ZGsWKHWM3NSGBlYIl/xe5TI/Q34wukF5JOizt4L+Rb4ENMx7LGA334LVF42Bs7cIGPZuWY2w01jiY9d0wB2ssQXKTwlEY4b2Yk0XJCd+ULTQu65SJ/SWoyihijQTgMRLqPhDEvLLu7rqOw4F/A9UnVlID11ZsvDgzJERkJt0oT78mH7U2ODtFm4HQETQrC6EIAJY4arwWRtRDxxPwK8IPEOwvmBeig6wHtx7zIgL8XnsN6sNyxKF3BXSxDFkMIagxe2TIx1jlXY4JDW0yl5Ln2ITLQ8mQkPw9R7NApbPmQSBzKXq0lkL4aDu8JHtuIhgAe8wheTd/1H5UvkqfD4GndpUkBmsLU/PWQ6PSVezlJnXfPB4ejtXff8anBtPK62x9ELbVCa0A9Stw8iAxcgITVwSYFHDyKFjc6AJ8GSnhFTmoMVluGQ3olMsWRC+6FSntBCirQI8OCKD5UvX5AsmOF9xctEDHl8oxuh+jrlmx5M/ly4HmqxWkCi07bVoVrpGa4IvdwSa5SPItnxjy9TqbPqUlTTIopM8fSroxDhOrtKsBADqav4bHugZfeyHsSqoZjLF61YerrqRup8EljkSPe/WDNaFlDljAptRXxVvGm7DL0txsT7r8J2+vhHILv+ikW9+znSqbGBvDxHJOYhynl+29M30sXgaZXcRdXE/GkqFen6Z9MKf5evS1RkSc+j1lYPt3wz3LLyNKG2I6tfq2HRoYMvxHIwY1WssAIc6py8VbBKPP22zuov1iSIIc3v4UalalZFVEvOaSjhJ8upRFoTS55VQYGnefSeCxPSQrZibzCbRQK+yH1Dcz9QPaVbEKdNUy9H+Yp/LgM3UDA+MTnB/vLJh4QuxmKBKop7noIB36xTZ7eRVI1MyKRqKJrhUgzHdzDGIleQUmjk35XQQGr7QZwN9gRykhnfrDOapjKMIpWJgdn47gyqmX/W6/9yceDDu0Pym2N9Uy/wPJlQsZvUo+8e8OvJLDsdx8oiA0gAEEg0EgpOyk8u9FUq2KcH4ehlpRkMFTzQCQu4lCXfyoMw4GpOdIYjVKulb+moVs9YVfyOLwCuQVwA/+Iaw4jag08fPt0IFztqLHqobueOBDx6OXvGgNPfnDkRgFhkzVhe240xQOyqOuy8lr4so8ZKWVOjknn1CbIjSEWy/5qVxSHOwpMOpEGkoEs+JpfLjKfWGkpwlHQJ420fo3W+oV6i/sCpvn79/wnLtTU=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Access Request Status' (list-access-request-status)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Access Request Status</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/access-request-status"}></MethodEndpoint>
|
|
|
|
|
|
|
|
The Access Request Status API returns a list of access request statuses based on the specified query parameters.
|
|
Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.
|
|
|
|
## Request
|
|
|
|
<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":"requested-for","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"requested-by","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"regarding-identity","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"assigned-to","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the specified identity which is the owner of the Identity Request Work Item. *me* indicates the current user.","required":false}}></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.","required":false,"schema":{"type":"boolean","default":false},"example":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250},"example":100}}></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. Defaults to 0 if not specified.","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":10}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"example":"accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw*","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified, accountActivityItemId, name**","example":"created","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of requested item 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"}}><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={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the item being requested.","example":"AccessProfile1","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`, `null`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT",null],"description":"Type of requested object.","example":"ACCESS_PROFILE","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"}>cancelledRequestDetails</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Provides additional details for a request that has been cancelled.
|
|
|
|
</div><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comment made by the owner when cancelling the associated request.","example":"This request must be cancelled."}}></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"}}>
|
|
|
|
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={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date comment was added by the owner when cancelling the associated request.","example":"2019-12-20T09:17:12.192Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"errorMessages"} required={false} schemaName={"array[]"} qualifierMessage={undefined} schema={{"type":"array","nullable":true,"items":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"title":"ErrorMessageDto"},"title":"ErrorMessageDtoList"},"description":"List of list of localized error messages, if any, encountered during the approval/provisioning process."}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"RequestedItemStatusRequestState"} qualifierMessage={"**Possible values:** [`EXECUTING`, `REQUEST_COMPLETED`, `CANCELLED`, `TERMINATED`, `PROVISIONING_VERIFICATION_PENDING`, `REJECTED`, `PROVISIONING_FAILED`, `NOT_ALL_ITEMS_PROVISIONED`, `ERROR`]"} schema={{"type":"string","enum":["EXECUTING","REQUEST_COMPLETED","CANCELLED","TERMINATED","PROVISIONING_VERIFICATION_PENDING","REJECTED","PROVISIONING_FAILED","NOT_ALL_ITEMS_PROVISIONED","ERROR"],"description":"Indicates the state of an access request:\n* EXECUTING: The request is executing, which indicates the system is doing some processing.\n* REQUEST_COMPLETED: Indicates the request has been completed.\n* CANCELLED: The request was cancelled with no user input.\n* TERMINATED: The request has been terminated before it was able to complete.\n* PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified.\n* REJECTED: The request was rejected.\n* PROVISIONING_FAILED: The request has failed to complete.\n* NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes.\n* ERROR: An error occurred during request processing.","example":"EXECUTING","title":"RequestedItemStatusRequestState"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvalDetails</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Approval details for each item.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"forwarded"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the request for this item was forwarded from one owner to another.","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"}>originalOwner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Identity of orginal approval owner.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"DTO type of original approval owner's identity.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of original approval owner's identity.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of original approval owner.","example":"Michael Michaels"}}></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"}>currentOwner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Identity who reviewed the access item request.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"DTO type of identity who reviewed the access item request.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of identity who reviewed the access item request.","example":"2c3780a46faadee4016fb4e018c20652"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity who reviewed the access item request.","example":"Allen Albertson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"ManualWorkItemState"} qualifierMessage={"**Possible values:** [`PENDING`, `APPROVED`, `REJECTED`, `EXPIRED`, `CANCELLED`, `ARCHIVED`]"} schema={{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING","title":"ManualWorkItemState"}}></SchemaItem><SchemaItem collapsible={false} name={"scheme"} required={false} schemaName={"ApprovalScheme"} qualifierMessage={"**Possible values:** [`APP_OWNER`, `SOURCE_OWNER`, `MANAGER`, `ROLE_OWNER`, `ACCESS_PROFILE_OWNER`, `ENTITLEMENT_OWNER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["APP_OWNER","SOURCE_OWNER","MANAGER","ROLE_OWNER","ACCESS_PROFILE_OWNER","ENTITLEMENT_OWNER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step.","example":"MANAGER","title":"ApprovalScheme"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>errorMessages</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"}}>
|
|
|
|
If the request failed, includes any error messages that were generated.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its 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={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comment, if any, provided by the approver.","example":"I approve this request","nullable":true}}></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","nullable":true}}></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"}>manualWorkItemDetails</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"}}>
|
|
|
|
Manual work items created for provisioning the item.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"forwarded"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the request for this item was forwarded from one owner to another.","example":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"}>originalOwner</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"}}>
|
|
|
|
Identity of original work item owner, if the work item has been forwarded.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"DTO type of original work item owner's identity.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of original work item owner's identity.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of original work item owner.","example":"Michael Michaels"}}></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"}>currentOwner</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"}}>
|
|
|
|
Identity of current work item owner.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"DTO type of current work item owner's identity.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of current work item owner's identity.","example":"2c3780a46faadee4016fb4e018c20652"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of current work item owner.","example":"Allen Albertson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"ManualWorkItemState"} qualifierMessage={"**Possible values:** [`PENDING`, `APPROVED`, `REJECTED`, `EXPIRED`, `CANCELLED`, `ARCHIVED`]"} schema={{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING","title":"ManualWorkItemState"}}></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 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 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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountActivityItemId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of associated account activity item.","example":"2c9180926cbfbddd016cbfc7c3b10010"}}></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={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","nullable":true}}></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={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"}>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"}>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><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningDetails</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Provides additional details about provisioning for this request.
|
|
|
|
</div><SchemaItem collapsible={false} name={"orderedSubPhaseReferences"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase.","example":"manualWorkItemDetails"}}></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"}>preApprovalTriggerDetails</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Provides additional details about the pre-approval trigger for this request.
|
|
|
|
</div><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comment left for the pre-approval decision","example":"Access is Approved"}}></SchemaItem><SchemaItem collapsible={false} name={"reviewer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer of the pre-approval decision","example":"John Doe"}}></SchemaItem><SchemaItem collapsible={false} name={"decision"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED"],"description":"The decision of the pre-approval trigger","example":"APPROVED"}}></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"}>accessRequestPhases</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 Phases that the Access Request has gone through in order, to help determine the status of the request.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"started"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The time that this phase started.","format":"date-time","example":"2020-07-11T00:00:00Z"}}></SchemaItem><SchemaItem collapsible={false} name={"finished"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The time that this phase finished.","format":"date-time","example":"2020-07-12T00:00:00Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of this phase.","example":"APPROVAL_PHASE"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `EXECUTING`, `COMPLETED`, `CANCELLED`, `NOT_EXECUTED`]"} schema={{"type":"string","enum":["PENDING","EXECUTING","COMPLETED","CANCELLED","NOT_EXECUTED"],"description":"The state of this phase.","example":"COMPLETED"}}></SchemaItem><SchemaItem collapsible={false} name={"result"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESSFUL`, `FAILED`, `null`]"} schema={{"type":"string","enum":["SUCCESSFUL","FAILED",null],"description":"The state of this phase.","example":"SUCCESSFUL","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"phaseReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.","example":"approvalDetails","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description associated to the requested object.","example":"This is the Engineering role that engineers are granted.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"removeDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"When the role access is scheduled for removal.","example":"2019-10-23T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"cancelable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the request can be canceled.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"accessRequestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This is the account activity id.","example":"2b838de9-db9b-abcf-e646-d4f274ad4238"}}></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, if any were included in the corresponding access request
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} 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 \"name\": \"AccessProfile1\",\n \"type\": \"ACCESS_PROFILE\",\n \"cancelledRequestDetails\": {\n \"comment\": \"This request must be cancelled.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"modified\": \"2019-12-20T09:17:12.192Z\"\n },\n \"errorMessages\": [\n [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n ],\n \"state\": \"EXECUTING\",\n \"approvalDetails\": [\n {\n \"forwarded\": false,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20642\",\n \"name\": \"Michael Michaels\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c3780a46faadee4016fb4e018c20652\",\n \"name\": \"Allen Albertson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\n \"scheme\": \"MANAGER\",\n \"errorMessages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"comment\": \"I approve this request\",\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"manualWorkItemDetails\": [\n {\n \"forwarded\": true,\n \"originalOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20642\",\n \"name\": \"Michael Michaels\"\n },\n \"currentOwner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c3780a46faadee4016fb4e018c20652\",\n \"name\": \"Allen Albertson\"\n },\n \"modified\": \"2019-08-23T18:52:57.398Z\",\n \"status\": \"PENDING\",\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 }\n ],\n \"accountActivityItemId\": \"2c9180926cbfbddd016cbfc7c3b10010\",\n \"requestType\": \"GRANT_ACCESS\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\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 \"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 \"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 \"provisioningDetails\": {\n \"orderedSubPhaseReferences\": \"manualWorkItemDetails\"\n },\n \"preApprovalTriggerDetails\": {\n \"comment\": \"Access is Approved\",\n \"reviewer\": \"John Doe\",\n \"decision\": \"APPROVED\"\n },\n \"accessRequestPhases\": [\n {\n \"started\": \"2020-07-11T00:00:00Z\",\n \"finished\": \"2020-07-12T00:00:00Z\",\n \"name\": \"APPROVAL_PHASE\",\n \"state\": \"COMPLETED\",\n \"result\": \"SUCCESSFUL\",\n \"phaseReference\": \"approvalDetails\"\n }\n ],\n \"description\": \"This is the Engineering role that engineers are granted.\",\n \"removeDate\": \"2019-10-23T00:00:00.000Z\",\n \"cancelable\": true,\n \"accessRequestId\": \"2b838de9-db9b-abcf-e646-d4f274ad4238\",\n \"clientMetadata\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\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> |