mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
201 lines
127 KiB
Plaintext
201 lines
127 KiB
Plaintext
---
|
|
id: list-identity-access-review-items
|
|
sidebar_label: List of Access Review Items
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztPf1z2kiy/8oU98NuKIMBg7FddfUeh7GPW8f4AU7uLknlBmkAbYTEaiQ7vlT+99fdM/pCwmAnm022pmprY6SZnp7+mv6YGX2q+GsR8NDxvaFdOau4jgyHtvBCJ3zoWZaQcizuHHE/DMVKVg4qIV/IytmbSl8EoTN3LOopK+8OKraQVuCs8TfAmS4dyXo3QxaIMAo8yThD0MyfM05g4QXCZQ4CZnM/YNxjjh6ZWXy15s7CY1Z2nDrrsdD/IDx274RLNhpfvu+dvxxeM+jdH4yn+hePwqUfIBgHh/ktcgJhQ0eA6ros1JjVmZqZCNTw9Dw3HLT3GHdloWMyOdsXknl+yGS0XvtBSKMJGSqIOWBAASlhRgqTS/9OBB73LMEuAz9ayzrQds0DvhIhIAQU/lRxkI5rHi7hlQcv4Jdjw9/SWooVr5x9qoQPa3wqw8DxFpXPB5V4spWzMIhEkSdiF4XZ8BxGEB/hpYugxfzoZH7aPmp3xWm7c9yadWazk3arzTvHR6dd+wQG1YjCvIOHFFPXWTlhZRODl/wj86LVTAQoCIGQkQu0AnooKam/9SZCsDevjoi6k5B7Ng9s1vddV1iE301Co3c/L8NwLc8OD21xJ1wU47rkjrv2HS+sW/7q0LG9Q752DqWGU7MSOLWU1i+IVys/AOJ48OdKiVolS805SIHI0KXVaZTwAcYVCxFATwVGPTpqwYOV4zmraFU5g34r/lH9TVBsMedABfr1eRs1/flciiI5R/QY0AYKhsDceQRiqqjK4EWd3coIJPeBybWwgMcge6Q4VeJOFQm/5gvH46GA/iCHiyXB0Yz5YdjxBcxIyL+d+JYfeUXaD+esikpWBQsGVAXCr/115CpSClb9Z23qh9yt9bF3FUm6BiMg2FJwG8Sf+IANS9RhyQGiH7k2mwmtGcA5Z57wDejHqkomqgwMGJBq4QHFbOAY8MxBs6ItERgGML0hosJoImTUlvxOwGPgEREH2ztgDqzwAGdDVhM4thKeDQOjfQNJkQJHrRKQv9LMq4gTYXvH3UgoKmBrQDuSMTY/hAQpc1kQopnvu4J7lYycUM+irBRAa+GZOy4Z9EfNdl6yLqhLIg6RRB6iqMTTZvLBC8GSqm4zlA3vG9P4L2pegFlN4/kCmX0RP0UZ0msioKeWV7BPAMq/x9dgi1xbkiAr/8MP5BlCqFYdu1o9Y1XxG8iiV1XPkGL6qX6inIh68QXMATgKoyZQPFGNIau1bxKtVjx4qJeNtNkG2Zi0kvf50csA6Ffl/Qi2K0Cxwrr0o8AS14/Avwl8ILPY0jK3Tjs2E7+xtzvX67eVrSu2RF6RpBZkeZvoZmwrmgtekwJFBIiPUp1il6HJQW3b3AoWdqIcqu9ZC5BmmzowUc/20wBgZ6nIHbAszVhG2g9YuRDFjcqEZivPM6CexPjPedlT+A9SYAVebtg0WE7I+S8LBWhBAY6EHPgJDbn3gKsjsT5xYzbELUsTcGElrTw9j4kg8AO1LvmWFQVqwQLOEA+RRbhOaadIa11trSgoYX2DztVq4KsfXDLfA2fK94RGCJZzIqgCJ2lp1Wsfg0nAuuusRH0r9TfGezYDcoxvfnPaZ6bhiudTPyuLvzvpCfCzCQ6jBGOA8M1JjWh/XQoXZf75tH6H9FRurkQKthoN/CdPot5jeQAgqOWD4w4WBDry9drVcenhrxJ7fyryhwcBR8aq/ulzf/Yr2GuMqgO076GjcFKDalNb1nwDW4+pN2zpu3a8BGnMiYVA45nAF2oewt4y5G7U1NtNemHQjm+QYjhHPZqO2mm4zUVZeBjcvKn0+v3R7fX0fX80Hg+uetPh6Br+vr4YXkIjeDmYTN7fjEcXw6tB+mA8+L/bwWT6vncDr171rtQbhIN/3dxcDfsECX71ey9vesPL7J/vAdh0MMYng/F0eJFpfHU70W9G19eD/nQ0fj/p/33wsgePBtfT4fRq8HJAo1yOXg3G173r/uD95Xh0ewOPhufU5F+ZPzOoJ4808vDoangx6P+rfzV4P5n2ptjopjeZvB6Nz9/fjGAOCGk8ot7jW/pnMsq8moxux318Ou1dqv+/h5kMLkfjf9HPyS8w1uT2CocaD25G42n6GwG9Go6u4pnHbOj1p8NXag6Axy9qau+ydiUzS9JUeHQe+lNkL9gfxy7zwIrSMjyPDckWeUkHbFmnzZPGyXG3edw4aR+fNJrd5unpUcvqNDtH81kXh1UWc5+BseXeQ2e8BfKO+uC3ow085yGfcQkz/ow2N+NTlCiQF7kun6UBXF6h9iWYk/pnIufDFAjV6TZPWkeN44YmVLfdso6POp2T5xNq24j9679mHb3ZbNa1jjuNQrj4qUCEx8cfpiEx4zM/Ch/F4tK5E2iiuX14HwBPE9OnEk6WZpqdMA154NzBUrIQdmkgncDWC24+sC5ia+MKADg4BXKh6eUsHS43CUDEv/dE8HSpic3wbjaSWcbFkNbLGWqe0l+dIXYU5Wr4ulKq53tqdZyQB0mt5wB1mqizHfuoNT85bVi82TlpalE96tgtsb9Y/j1aca+G6CJlmO3ItcsfEkmNffxdM+vB4g6CdSGCRSR98ppWEFjtHn+AzRi37QDF6wkjchqxPlcj/m/cTfrwEMSzglYkNqYxHccCmgvPEq/BMcIQqefZhAAizEPAcBaFKih9sj4n3UEqlDdHgVgO55XAnN9onhvuFebQ9htPpdueMOAjxkS1npBbNSINme6tAMoZiz0k5aVkcVAuIqX318BX1NlNHcYMkAOucjILmUN8QcWRFM/n8URjg0b+fulYS+UjZ9GYCdf3FvmxR+eTWu+8NlHkTFDYnzyx27YFBbETg54Vgv1l5xChWKEPDnhN/51iM3yyU/AsTLonFj+eiU6zac3azflsdnJsz3hrblm82z1pWIjQkssbEawcKakkuDuL+iRjD9AxXErAb64kaEoz43/t4WmtScRYLZ8Yw3i4IlJePUWuDDeIDnxLLTpfgNj9UgBiBVcljshwkA95PwtXOBjecv3IVkXHLevy4yhMAcwWshBotohhl8wdQzqIciW6dr3NYCiLwT4johyc9ybkcpSgvTlxu2zMLcFeDHaLN/i427D2IVbNuRBJaJof5UqHv5aLBeGk8Br3V1Elhr4PynIqfZUFQrx9y5R1JJIkftn+ofDdfgvOq+xiQ1jmF+DL85txrdVAfx15DXK68IMvIEQK4fsmhcYzTwzydmoUN4GPbS2p+ldalcxDvk6qgNRNZ4wFB/NcNk6zoaitinYTyw/EV5vkkGAyAppujNDqls70pbCdaKW5nkSrqbaha6Ms4z4u+D4xigSzG8nyuCk/U4/juhl7e/v6C7TWJvsjkpnHs9jwp4qeLvjMOKX9zGsxDNpl8VNUyOpGAXiwIWhGMiyg4PrWh2+OgB7088HW0MkkpH6ohFQhBYr805vEYvVDFpMunk9H2UIXppodFQPE+nft32MhPuAgD5EVRoHIB7H7ZL2eluPQSR1YVnzL4TFaceq2oM355E5HxMmdo66YtU7FcTaKfjoisc54qsb5WKxsQYgbir0mnBRewTCLGibgC4O/XgovO2d2D4tjPERu/o1Wo9ZowyI+bTXOms2zRqfeOO7+m1Yx31a5u98RJ1j/Q5YMVMSsg5g1T8463bPmcf30RGHGMTgC8Rp60lkswz38u7il2jAVYxDDKawiusHwfPcCcnubxldlEma1bdvutFtN+6TTPp03+Mw+apw2j1sWn9tHsybOJ5J8Ic75gyx1F/bbUXbaKF3aEufCBvCq9JLMOUGy3ckiMYHF9lFb3h+9vLkakCG7vf7levT6umg6JmrFdtRiQkXxmEZqfFpI9IYNrEdF3gfPv88FUOlAWUejt8n8vB+idnairA7yOcFcqXS3y/SEDLLmvvJ+WDxCiZnhYFwaduM4NjMnc8tuNbqnrf2TddeZ3MYjAw7gX/9BiFqcnqX8Xo0SuSV55OfkjR8ZPbPzAlDN1h6VM5+klMmb06g+JZP8lTLFZQHrHtHyV4uOhWefa137CgYWpRHfYmFWpXc4ZuGCn5K4SHxcO8FGmg3sbLPWbNVanWmjcUb/1RuNxr9NGt2k0Z+TRi9sVEYZ2mKx8lW+3WmDdANBzqYUnT3co79pnrbmA0wl0VQSTSXRmEBTSTSVRFNJNJVEU0k0lURTSTSVRFNJNJVEU0n8RgiYSqKpJJpKoqkkmkqiqSR+35XEvIo9ztLz+E6IfDY6q0T1bTK/UaJp4H/TVuvsqHXWOak3G+2Caj0fl5zy7I1RqwSjUvr1cqVXDGT98hLsV0/F66OaOyuxp43u3G50T9vPz8EXhuopHcZD4nE5Vn6l2mthLHyg7r6grKDcsCOoNTYeJQ0p1ElvIBHIGB48bAiF/ENrsCbnbnLuz8i578qO7c6GkRbl02C4oOj7dHbW8L+kZn+PPs2Wen29aHu3FOxze1x2J09w9LiiumEAyouq2u7smRAxW2jMFhqzhcasZWYtM1tozBYas4XGmEBjAs0WGrOFxmyhMVtozBYas4XGbKExW2jMFhqzhcZsoTFbaMwWGrOFxmyhMVtozBYas4XGbKHZuYXmqWn/bKV3d+J/V5nXpPtNut+k+02636T7TbrfpPtNut+k+02636T7TbrfpPtNut+k+02636T7TbrfpPtNut+k+026P6xsaUJJ5jzw7PcZyQYpS/bIJxufl3nOfCYv9jukHqPEQHW7Ld5ptOcdMFAtftppNwT8OeNP+ERe9siR63h4riweeYdtips9PeGQTG2PrwAWEuxH3S4/OrJpKUg+q/2kc0TZmDn39dM4ytugw08yRlEHJPSh+pkAw5UisBloZqSnn+083JCcPRO+0zyugJKTJ9eub2w/lVyvy4mU1c+yyN4T93sH9Ds5goMhT7z0a7VopkvymfHwtrCcjWTPIwSNWxPUNSjsnVCHKjFpsolM1mslx5Mcs8Gr0S+D/Pcy07elAnAeo6gYkhTJnuZH9HXPNCrZQDVBh5LleFIMwiX8JK8nhC1zVRv8JrhOaRZsnjKKQwT6WVnUdtn3c/uug2H3gL78W2NjAU6dhyo012SkY6ps5ttk4R0PQk9Vunjql3W32FdbhBBn9317D5N34Xiitgi4gxiqjxVb0JGhADj0Od0VRroKZBJdYru8mwqUqDfZ37gN81Xz6+vJIBkDbn0AWPtYx1vPgf4s7pIrPxaHFV3BZ8eN01Z7ftzmvHXSbnY7s9M5WMXGaef0lJw0PDu/2CPlcik8ETgWhmzAkf/i15wFR0NP2QYcfP+cCcHYMxOu2ibT1PiyUHwMD0DD/9a/Ye0u+IHeIqLnfLFBBK92OymkDVTAC4BHgbNwSq1ArMPng4teHBzpiAxhlQU72lvxyWFaQuwSphNAb1UKPA8r7DqraqhVmBD3ZLaho37JB4mGTcfe0EOPXtIjC5rNA3+VUyXSm48h+9mpi/oBrEboMWOmiGHZ1Y7LLlVU43VYu9KUrLKl4LYIXtRZz7YdnCR3VflIQn8qWnLbRtVVAOYRxmcULmHaxfNDx9oI11JSFmyYtiVXWaagcgDmu+UEXLoIkKNpZrUwkRaNouYP4KwoV9+wfynRiKQPXojeJrR0H4CMAZZP2AzmhlUnbY6QXRIMjxe3SyxW1kSSuXupkIEAVe0e4ZHcQ+9uXDA/NZpa8uJOaOUju6ysEXEjZpO2SLrUTp11q4RdseIz8Kdc2+iu0V2ju3vq7ubLsZBr0MX4Lbk+zaLrc+vxCOgb0OJZcH0Ckh4P/EvdSEcQxMgD9Da1i/SP11NQ7A8QUzjxUf6v6R+ppbyAfC/hh3o+Q/cjYVaOF4gg0VHNYA6WSNhnhHeKsXISiVRHxdEu/GDmgIB6JS4ieagPfsQ4kCyIPA8x4fKA2b6Q3k+hCro23Fbh2bW173ih8SSNJ2lWI7Ma/XlWI+NJGt01uvtj6u6jnmSCFWmL9pPiHL8qrqr3VJZh0AD3uVB/lqhcsnMj660gMJb4WJW851CZtZqz5rxribbN2/bx0em8ZR23eKfb7DZn7Va3kl3r36R6nChZXqcy/FZ8VPs/RXAnsGoDwiVD37fz6T8gbyDmaNYo5Rr7zUBzIOm71HdsF33Haz+EuQFg8B2DLenF2/EVwsdLJilPHO8PQjc73pKKG4jQpUQZBko7MjSuo3EdzfJjlp8/zfJjXEeju0Z3f0zdfZLr2N7lOraf4Dq2GbpYc3Sx/kjX0Qa/A12zOTAF5qA3lW4etIjVPuTBQoSJo5fzIlunRS9y6vvsJZ5P1M6SzGUivZRcaN6g7QrbBnFbB+9BXoCJ9PBsh+Ory4GdlUCfFA/gus7KIT3GCQHc4KHWm4cwK6Uzsbwlozie5UaAIRkFPGOD495zB4/czNH9AwiUB12Aof6KOU7NrS/KB7MxzvgKZ8wGHy0hUOeT/G+nbJfAEJAP0FxMFK+3bBdQOXPuQRghPq6V+UpcUOOqG1fdLPdmuf9zLPfGVTe6a3T3x9TdJ7jq2hva7qpDg71d9Q7e4c8SX+qCDnF9a4+dVEVjQOLNfIt8dTv1wcmvAFFChMBLRxvCwyX8OMxtp5aHnxz786Eq7dfUNtaaMkMHFRUVKCSjwIXOyzBcy7PDw0/AO+DZ5zpfO/V4q7bn3+MdD4d3RyWWSF0agVIEtsyO1CcsejdDHXrUieKBg0KtLCANoOivj8pVJPCBdhw8Cj++auABohKmwBzgASktYPRY35Tyk6TWdRKowhxhbreB+3nXfF4dPTYPBWTLPMrI9+hY0J4BlhvTQ/TfIbtACOiEJfDrFvDpK9PVi5Dxb95l29ANEwrDQst0+cEiQauA0AibtdjfBA9w2zjtm/n5H6+nL9gCHVQyEJFE31g4GFGAit2AGJEB7MV7SLATrUmBHy3UYbBebpcOKhybu0AU9tabCMHeZE+wjcGUE9mxkyDrgb3e/RxzzxZ3wsVFs55SG4XTsb1DoOIhz/V7oT6ShZGEk552rb/14iseUFWojZ4iBYbszTqeF8/M67lI/CWGVtPqSNDkiw0sFGnfWGrXtwVajyC4K4lazx5cwatl4GHYBU8Q6iYOSAmNR35vlRVz7dl45ODVEF4ej7fea/UFllw3powdk7B4ujYbMmvp+1L8D2MoOqgqbxYRaNqz0aLLOWqkEbVWI4NSTQ1Zc2rgSxJ+V6AYnhImdVyaXBlfZVVIbf9DnAW78B+6ceU/uTnT4zew5GJL27fks3HGAWs4YE3ZCanxVysaChboNs6B7IASgH7Kf7IEGtGMXVSwSi0/gT+kPrh8WIAqQZHrM/XjLDWC+i9GL7B10gbMNLri6ZkT12UaFi5rOWLFSYRNChbxdX1YTTfopvBNSqG4wn5v88UZ99Jcy8hzH762ld5iSb4fu/sHWTxjaf6MlkY7xyhuNOzGZWQo5MqjK2b+JJ1Lg//DW9JU8sLxeo7kQHsWzNrlIco06bS1dATlDNYCb+dzxQHKlb8iPQSXGJUfD+MhoAWdCg8AYQ5RnuPSvWuv8ZINC0iMARnu1QWov/o6MpsAlW+QSew8ZhzDU2qRpy/PiFb47bJd3LUdaUXKCEF85ol4Zj65cUmvWCNRbJAUdQpNgpUczTG5DHFrhok7xgIeSp1ZBkLSWTw6OltJJzIWropVoF3eRd8FGySnthTumi7jALQgwMuM8HI4LUAEYJ4uZ/jB4lB3kofYFoBgOKSE4agOgSBdsOjLEOLXDNyr/KcT1Sk+NtRB1cZ1kUlKXfn5aFrVDhu84Sq+mlOvDYXzstxLj/NaENFyZ+Hlj8vWWU/bfmLkaHz5vnf+cniNvjdewaF/abOgjoBjEI/7yUkMcDEKNWZ1PReUgOToY/50Ll59BQpd6JhMLtn+oy+pSAs8CDEfm+KVETAjhYm6Lot7lmCXdLsQSZ1aAjF2OVxjlo6O7qt4S8W7byp5mNDpjE7vloW8ECAtgZ3Y69MnTO9g/PcZHwOOgQqs0ntlyq5qyTL0Jf+YOewfCAlGSH+mERlc18urjh8nIRhoHtgs84nHGx6ASIFqPcEySw0HXOcYTm2dwNmy4G4j5QeBCROqrKUpkUoFg+X96TCaz6UI1TUPKtMFoqHIAVFzWGe3MqLQXK6FRWfRlbBWadwq5Vc5OG/qlt00XtQU/XHo6BMhnk/I4ZxVMd9XBRMAJAIqrv115Ma3D1f/WZv6IYSPdM1VNc1p6QJo+nnnolDizrx7cmjo4rq0JBgzAb2HqppAld1TmXDh+ZhyQkdk4qBealVWsXGIqDB1qQdaBXWEBGu3RC5sr+7LOsDZkNlRJ7IxJ4oGAtguBY5aJSB/pZlXVZkSsFW3bhIVsPVMXW+psPkxxCG+mOSZ0nDhuOgkxCxUSzKlvuMpUwb2Y1xNVqnmb0sXcAwRScCspvEkv/Uifkrp3+S2orhIMQdQ/j2+psKIJOFDHLA2IM8QQrXq2NXqGauK30B+vKp6hsTWT/UTZeXrxRfJdQwJFE9UY8i5WyLqZSNttsGlP2kl7/OjlwHQr8r7ZW+HTW9a3QZf3/69peXjMqj4I58vhRO1hn/PMigBxU0JnKhn+8kfELOU4Qcsw8XkB1L7gJWzMG5UxrLHGYWT+CJGbZgLsK7kTJa5lmRfsd7IHXU9h/eQXFebLNForHlNCiR0mL/umw3PJRlirLRQIYnMNBUplP0GshODmLoeI17wtUDX1vpr42DuoXO1GvjqB5fqcm/fi6/NgdWNXDMFTsZXrxJMvK2SdgjtsMMZzL9j+mZI44rnUzg72W9D3g2efr8URjJ8XcIWxfn3ITExMEfYd2kZ6olRy89jHf69oI10O+JLoNc21OItFd5DFrMYZYjBPr/Da6rJNyUc1QtVR890Kew0w8kltc3LAQTmn/8f/eREvA==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List of Access Review Items' (list-identity-access-review-items)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>List of Access Review Items</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/certifications/{id}/access-review-items"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API returns a list of access review items for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity campaign certification ID","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","required":false,"name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**type**: *eq*\n\n**access.type**: *eq*\n\n**completed**: *eq, ne*\n\n**identitySummary.id**: *eq, in*\n\n**identitySummary.name**: *eq, sw*\n\n**access.id**: *eq, in*\n\n**access.name**: *eq, sw*\n\n**entitlement.sourceName**: *eq, sw*\n\n**accessProfile.sourceName**: *eq, sw*","example":"id eq \"ef38f94347e94562b5bb8424a56397d8\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"access.name,-accessProfile.sourceName","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName**"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"entitlements","required":false,"schema":{"type":"string"},"example":"identityEntitlement","description":"Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs.\n\nAn error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"access-profiles","required":false,"schema":{"type":"string"},"example":"accessProfile1","description":"Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs.\n\nAn error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"roles","required":false,"schema":{"type":"string"},"example":"userRole","description":"Filter results to view access review items that pertain to any of the specified comma-separated role IDs.\n\nAn error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time."}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A list of access review items
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessSummary</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
An object holding the access that is being reviewed
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"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={{"description":"The type of item being certified","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","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"],"example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the item being certified","example":"2c9180867160846801719932c5153fb7"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the item being certified","example":"Entitlement for Company Database"}}></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"}>entitlement</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"default":false,"description":"Indicates if the entitlement is a privileged entitlement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute on the source","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceSchemaObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the source for which the entitlement belongs","example":"78ca6be511cb41fbb86dba2fcca7780c"}}></SchemaItem><SchemaItem collapsible={false} name={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement has permissions","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isPermission"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement is a representation of an account permission","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates whether the entitlement can be revoked","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"containsDataAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement has DAS data","default":false,"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"}>dataAccess</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"}}>
|
|
|
|
DAS data for the entitlement
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policies</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification policies that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the policy","example":"GDPR-20"}}></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"}>categories</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification categories that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the category","example":"email-7"}}></SchemaItem><SchemaItem collapsible={false} name={"matchCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of matched for each category","example":10}}></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"}>impactScore</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Impact Score for this data","example":"Medium"}}></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"}>account</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"}}>
|
|
|
|
Information about the status of the entitlement
|
|
|
|
</div><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently disabled"}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently locked"}}></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={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>activityInsights</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Insights into account activity
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UUID of the account","example":"c4ddd5421d8549f0abd309162cafd3b1"}}></SchemaItem><SchemaItem collapsible={false} name={"usageDays"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 90`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":90,"description":"The number of days of activity","example":45}}></SchemaItem><SchemaItem collapsible={false} name={"usageDaysState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`COMPLETE`, `UNKNOWN`]"} schema={{"type":"string","enum":["COMPLETE","UNKNOWN"],"description":"Status indicating if the activity is complete or unknown","example":"COMPLETE"}}></SchemaItem></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"}>accessProfile</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Owner of the Access Profile
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></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"}>entitlements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of entitlements associated with this Access Profile
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"default":false,"description":"Indicates if the entitlement is a privileged entitlement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute on the source","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceSchemaObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the source for which the entitlement belongs","example":"78ca6be511cb41fbb86dba2fcca7780c"}}></SchemaItem><SchemaItem collapsible={false} name={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement has permissions","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isPermission"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement is a representation of an account permission","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates whether the entitlement can be revoked","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"containsDataAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement has DAS data","default":false,"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"}>dataAccess</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"}}>
|
|
|
|
DAS data for the entitlement
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policies</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification policies that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the policy","example":"GDPR-20"}}></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"}>categories</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification categories that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the category","example":"email-7"}}></SchemaItem><SchemaItem collapsible={false} name={"matchCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of matched for each category","example":10}}></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"}>impactScore</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Impact Score for this data","example":"Medium"}}></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"}>account</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"}}>
|
|
|
|
Information about the status of the entitlement
|
|
|
|
</div><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently disabled"}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently locked"}}></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={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>activityInsights</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Insights into account activity
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UUID of the account","example":"c4ddd5421d8549f0abd309162cafd3b1"}}></SchemaItem><SchemaItem collapsible={false} name={"usageDays"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 90`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":90,"description":"The number of days of activity","example":45}}></SchemaItem><SchemaItem collapsible={false} name={"usageDaysState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`COMPLETE`, `UNKNOWN`]"} schema={{"type":"string","enum":["COMPLETE","UNKNOWN"],"description":"Status indicating if the activity is complete or unknown","example":"COMPLETE"}}></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={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}></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"}>role</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id for the Role","example":"2c91808a7190d06e0171993907fd0794"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the Role","example":"Accounting-Employees"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Information about the Role","example":"Role for members of the accounting department with the necessary Access Profiles"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","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"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the Role can be revoked or requested","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date when a user's access expires.","example":"2021-12-25T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessProfiles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The list of Access Profiles associated with this Role
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the Access Profile","example":"2c91808a7190d06e01719938fcd20792"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the entitlement is a privileged entitlement","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"The date at which a user's access expires","example":"2021-12-25T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Owner of the Access Profile
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></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"}>entitlements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of entitlements associated with this Access Profile
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"default":false,"description":"Indicates if the entitlement is a privileged entitlement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute on the source","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceSchemaObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the source for which the entitlement belongs","example":"78ca6be511cb41fbb86dba2fcca7780c"}}></SchemaItem><SchemaItem collapsible={false} name={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement has permissions","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isPermission"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement is a representation of an account permission","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates whether the entitlement can be revoked","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"containsDataAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement has DAS data","default":false,"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"}>dataAccess</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"}}>
|
|
|
|
DAS data for the entitlement
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policies</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification policies that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the policy","example":"GDPR-20"}}></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"}>categories</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification categories that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the category","example":"email-7"}}></SchemaItem><SchemaItem collapsible={false} name={"matchCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of matched for each category","example":10}}></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"}>impactScore</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Impact Score for this data","example":"Medium"}}></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"}>account</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"}}>
|
|
|
|
Information about the status of the entitlement
|
|
|
|
</div><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently disabled"}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently locked"}}></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={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>activityInsights</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Insights into account activity
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UUID of the account","example":"c4ddd5421d8549f0abd309162cafd3b1"}}></SchemaItem><SchemaItem collapsible={false} name={"usageDays"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 90`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":90,"description":"The number of days of activity","example":45}}></SchemaItem><SchemaItem collapsible={false} name={"usageDaysState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`COMPLETE`, `UNKNOWN`]"} schema={{"type":"string","enum":["COMPLETE","UNKNOWN"],"description":"Status indicating if the activity is complete or unknown","example":"COMPLETE"}}></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={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Access Profile was created.","format":"date-time","example":"2021-01-01T22:32:58.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Access Profile was last modified.","format":"date-time","example":"2021-02-01T22:32:58.104Z"}}></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"}>entitlements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The list of entitlements associated with this Role
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id for the entitlement","example":"2c918085718230600171993742c63558"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the entitlement","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Information about the entitlement","example":"Gives read/write access to the company database"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"default":false,"description":"Indicates if the entitlement is a privileged entitlement"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute on the source","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute on the source","example":"CN=entitlement.bbb7c650"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceSchemaObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The schema object type on the source used to represent the entitlement and its attributes","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the source for which this entitlement belongs","example":"ODS-AD-Source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of the source for which the entitlement belongs","example":"Active Directory - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the source for which the entitlement belongs","example":"78ca6be511cb41fbb86dba2fcca7780c"}}></SchemaItem><SchemaItem collapsible={false} name={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement has permissions","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"isPermission"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates if the entitlement is a representation of an account permission","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Indicates whether the entitlement can be revoked","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"containsDataAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement has DAS data","default":false,"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"}>dataAccess</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"}}>
|
|
|
|
DAS data for the entitlement
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policies</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification policies that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the policy","example":"GDPR-20"}}></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"}>categories</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of classification categories that apply to resources the entitlement \ groups has access to
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of the category","example":"email-7"}}></SchemaItem><SchemaItem collapsible={false} name={"matchCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of matched for each category","example":10}}></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"}>impactScore</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Impact Score for this data","example":"Medium"}}></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"}>account</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"}}>
|
|
|
|
Information about the status of the entitlement
|
|
|
|
</div><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity for this account","example":"CN=Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently disabled"}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"example":false,"description":"Indicates whether this account is currently locked"}}></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={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The id associated with the account","example":"2c9180857182305e0171993737eb29e6"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The account name","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was created","example":"2020-04-20T20:11:05.067Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","description":"When the account was last modified","example":"2020-05-20T18:57:16.987Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>activityInsights</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Insights into account activity
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"UUID of the account","example":"c4ddd5421d8549f0abd309162cafd3b1"}}></SchemaItem><SchemaItem collapsible={false} name={"usageDays"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 90`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":90,"description":"The number of days of activity","example":45}}></SchemaItem><SchemaItem collapsible={false} name={"usageDaysState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`COMPLETE`, `UNKNOWN`]"} schema={{"type":"string","enum":["COMPLETE","UNKNOWN"],"description":"Status indicating if the activity is complete or unknown","example":"COMPLETE"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></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"}>identitySummary</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the identity summary","example":"2c91808772a504f50172a9540e501ba7"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the linked identity","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the identity being certified","example":"2c9180857182306001719937377a33de"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the review items for the linked identity's certification have been completed","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The review item's id","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the review item is complete","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"newAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the review item is for new access to a source","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"decision"} required={false} schemaName={"CertificationDecision"} qualifierMessage={"**Possible values:** [`APPROVE`, `REVOKE`]"} schema={{"type":"string","description":"The decision to approve or revoke the review item","enum":["APPROVE","REVOKE"],"example":"APPROVE","title":"CertificationDecision"}}></SchemaItem><SchemaItem collapsible={false} name={"comments"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Comments for this review item","example":"This user still needs access to this source"}}></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 \"accessSummary\": {\n \"access\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180867160846801719932c5153fb7\",\n \"name\": \"Entitlement for Company Database\"\n },\n \"entitlement\": {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"sourceId\": \"78ca6be511cb41fbb86dba2fcca7780c\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"containsDataAccess\": true,\n \"dataAccess\": {\n \"policies\": [\n {\n \"value\": \"GDPR-20\"\n }\n ],\n \"categories\": [\n {\n \"value\": \"email-7\",\n \"matchCount\": 10\n }\n ],\n \"impactScore\": {\n \"value\": \"Medium\"\n }\n },\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"Alison Ferguso\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\",\n \"activityInsights\": {\n \"accountID\": \"c4ddd5421d8549f0abd309162cafd3b1\",\n \"usageDays\": 45,\n \"usageDaysState\": \"COMPLETE\"\n }\n }\n },\n \"accessProfile\": {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"sourceId\": \"78ca6be511cb41fbb86dba2fcca7780c\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"containsDataAccess\": true,\n \"dataAccess\": {\n \"policies\": [\n {\n \"value\": \"GDPR-20\"\n }\n ],\n \"categories\": [\n {\n \"value\": \"email-7\",\n \"matchCount\": 10\n }\n ],\n \"impactScore\": {\n \"value\": \"Medium\"\n }\n },\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"Alison Ferguso\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\",\n \"activityInsights\": {\n \"accountID\": \"c4ddd5421d8549f0abd309162cafd3b1\",\n \"usageDays\": 45,\n \"usageDaysState\": \"COMPLETE\"\n }\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n },\n \"role\": {\n \"id\": \"2c91808a7190d06e0171993907fd0794\",\n \"name\": \"Accounting-Employees\",\n \"description\": \"Role for members of the accounting department with the necessary Access Profiles\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"revocable\": false,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"accessProfiles\": [\n {\n \"id\": \"2c91808a7190d06e01719938fcd20792\",\n \"name\": \"Employee-database-read-write\",\n \"description\": \"Collection of entitlements to read/write the employee database\",\n \"privileged\": false,\n \"cloudGoverned\": false,\n \"endDate\": \"2021-12-25T00:00:00.000Z\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"sourceId\": \"78ca6be511cb41fbb86dba2fcca7780c\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"containsDataAccess\": true,\n \"dataAccess\": {\n \"policies\": [\n {\n \"value\": \"GDPR-20\"\n }\n ],\n \"categories\": [\n {\n \"value\": \"email-7\",\n \"matchCount\": 10\n }\n ],\n \"impactScore\": {\n \"value\": \"Medium\"\n }\n },\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"Alison Ferguso\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\",\n \"activityInsights\": {\n \"accountID\": \"c4ddd5421d8549f0abd309162cafd3b1\",\n \"usageDays\": 45,\n \"usageDaysState\": \"COMPLETE\"\n }\n }\n }\n ],\n \"created\": \"2021-01-01T22:32:58.104Z\",\n \"modified\": \"2021-02-01T22:32:58.104Z\"\n }\n ],\n \"entitlements\": [\n {\n \"id\": \"2c918085718230600171993742c63558\",\n \"name\": \"CN=entitlement.bbb7c650\",\n \"description\": \"Gives read/write access to the company database\",\n \"privileged\": false,\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"attributeName\": \"memberOf\",\n \"attributeValue\": \"CN=entitlement.bbb7c650\",\n \"sourceSchemaObjectType\": \"groups\",\n \"sourceName\": \"ODS-AD-Source\",\n \"sourceType\": \"Active Directory - Direct\",\n \"sourceId\": \"78ca6be511cb41fbb86dba2fcca7780c\",\n \"hasPermissions\": false,\n \"isPermission\": false,\n \"revocable\": true,\n \"cloudGoverned\": false,\n \"containsDataAccess\": true,\n \"dataAccess\": {\n \"policies\": [\n {\n \"value\": \"GDPR-20\"\n }\n ],\n \"categories\": [\n {\n \"value\": \"email-7\",\n \"matchCount\": 10\n }\n ],\n \"impactScore\": {\n \"value\": \"Medium\"\n }\n },\n \"account\": {\n \"nativeIdentity\": \"CN=Alison Ferguso\",\n \"disabled\": false,\n \"locked\": false,\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180857182305e0171993737eb29e6\",\n \"name\": \"Alison Ferguso\",\n \"created\": \"2020-04-20T20:11:05.067Z\",\n \"modified\": \"2020-05-20T18:57:16.987Z\",\n \"activityInsights\": {\n \"accountID\": \"c4ddd5421d8549f0abd309162cafd3b1\",\n \"usageDays\": 45,\n \"usageDaysState\": \"COMPLETE\"\n }\n }\n }\n ]\n }\n },\n \"identitySummary\": {\n \"id\": \"2c91808772a504f50172a9540e501ba7\",\n \"name\": \"Alison Ferguso\",\n \"identityId\": \"2c9180857182306001719937377a33de\",\n \"completed\": true\n },\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"completed\": false,\n \"newAccess\": false,\n \"decision\": \"APPROVE\",\n \"comments\": \"This user still needs access to this source\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><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={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><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> |