---
id: search-aggregate
sidebar_label: Perform a Search Query Aggregation
hide_title: true
hide_table_of_contents: true
api: eJztfety28jR6KugmB/eVUiKF1G3c/Y7oSXZq0SWtCLlTT7L5R0CQxIxCTAAKVlxqep7jfN650lOd88FMwBIgrK8azmoStYUOZeenp6+T8/nypyN4srhu0qPs8gdV95XKx6P3cifzf0wqBxWLnk0DKNp7DAnpibOvxY8unfYaBTxEcNWDgs8J+LzRRTEznzMrd8iHi8m87rz8t7x+JDB56pzHy4clwXOjI2gsTNln/zpYuqEQ6fZqDYaDTWT6Av/uGHkxXXH6Yeiz4zFc9VW/pqMuoi5HKA7nPMIe/jBCHpf8SH8OQ+dd5f4FcAXjByxbucXWJTP4/c/jOfzWXy4ve3xWz4JZzyqx8yfzEI/mNfdcLrte8E2m/nb8RxWzSKv5oaTCXdxrbUZi9iUw5zxn2Z6hpqApfYvMcOPDqDTmYYRd/wAMStROAgXc2cc3iF8/nQ24VMezHPXUalWEC7qd+rBFslGEukcfo+5u4j8+T1s7OfKdcyjozCY80/z7mI+xs2OZ4ei02HEmVd5/wDbngBPvXzcfNpqGC+AX+DPcDiM+bySJpEL+hqWA6Dj9g8Xk4naO/ih7lzHCzaZ3DvxjLv+0Oeec+fPx87WxJ/68y1csUQXh/5RuBiNaRwxRFy/CXqcO+/etp3u5anTk4h3jjTinUsN+1NtYP421WHtEf/Xwo84IH7IJjGvVvgnhvtVOWwA4t0xn7LK4efK/H6GKINZ+YhH0E8MIr5qt+CLqR8g2VM/eTTg88NDNR/5hKwM7t+wT06wmA6APuD4SIwhRsV5fDa4a3W+AHuSgchRNC7hr6XYdMNFkMXm6dDZmkcLvuX4c6BRIONZOFtMBGFyZ+vvtX44Z5PaEfbeQnTPwgDYzRhOEewAUTU2zNmRMYMRw8XEcwZcbg6cA3+oTwEy0S1xwracO47IGwWAQw/2EHbRD1zsB8uIiW8x2GQAxaGFEN8bs1vkpjPBsBm2B0bCXGC4sBo/Jk45BbbiwcRBOEcqiTnOukWD/EQr30KYCNpbNllwgQVsDWADZ5XQPAuawvXkENUgDCecBRWDUqjnA3JBieGXoXePXVzkm0Ao8JHNZhPfpWm3/xkjuXzOjh0O/gmgw9CzCJc6B4aPv/qB57vio01wfSQWWGKMtIKUczIB0ea7UgDKfvCvczf24QvaMvyp7gCtBmEAOw4ogdlufdjWKo4BwgS2THWl/RsoiQj7V0EMAUoDNjkO3RyYzqBlIFAtpFIKmDHQJo6yiCbQWm9v6C5QZIl9sbc4ZizeHvPJbFsMJf9hgwmvgTiYgGwfz6eTykNV4ZFFEcPT6s/5NAfEEzhgQM4zOF0wJR4HxB3IvAj+REGzmM3CaI4HTAANVNv1PB+7w5khyo5B77hHzDDPo4ZSdsHJ5HSScelA+NAdVysBi+cRTIc4DJDhvKswF4aPYQOG/gR2uIpf4GmCc+ff+kQA2Hjuz4VIpz9v5QfYM/xFNIpCMcAWKmGaiO02NAwyKjjEnxBfut07s+F7+IUYXp+gzqM6XA8SndDmgK7gcIOOZKppiI/fet3Ts8uL0/P+b6opdgRugsygKslSnkGh/f1G7X5zxFnAoQHJMKgfJGiWx8wZwDmDvenT9Ebv43gCA0TObzhbF9nrL+agcWocofxNFzEpHPQLgQlz/3bcOxND9f9xedL9+aR7/JuDexR5sJGT+69HGTAx/KXxB5/7J3+nfxQgQtuWPMhqmWy/+a3a/V/01qp9fgss0hc8CQ7/xZBUuOymyxOScJnoFsTUreict5YEuk69ZcEl/lYQyQEVGCh1s0OloZHzKtYnyEtsMNLEGIhMNZEClZjZlM0cqWkaI9iME4VFMqaAISYRqwhowJFtkESrPOjzksfKbcAJ904imGgIhAdEBcyzAIoHWWxDY60sIxz0xFkMiY6LWHE4e9h3ApYerY4smPtE3N7d3dW5aA48eHu0APawzYNtbg6xHaFJxEFV2Ib93Kbpal48qYlPAm/iD+LQfzK//9GJ74HPfXKGUTgl8AQ8QPcOShjSMwYAH8iCS5QFJL0EZ3bO4dTCz9Ioyj1GmtRQQB6yLSR2IS3ykSV+M7ZdiT6S3LRJwOBeiVZSYhLfILUNzFsyu5w7RuwQzj7+XzEGNbiSv1XNCKbso9oexUuRGKZCWwDygjmBGuVybDN1boAdSvPoXmhfBBgL6EOkKGjo3FTY1k1FMtVkYfA9YummUoVPQz+K5+fyT6R5nOamEsNAwLFEOzSmhYklNFjCFeiYkwUghWn7DVnh3B2rBcrZBTRDEHOSO4a0loir1dQd4Kri8ws4drdAAWzgT8AiBUEwA8oAfUdwVaVUiOOolZQUzkAlRXygqiOaYOMbQ+LhShViESv3Am3yoEhuYWFGQFd1BguBaxd18+DFnPbFbqnoQwwGgN9Iqe8osU/41O6FuYlYoSJqhoTfo3ILqvrEj+ek90n8TBLsVZYrQvYxsTUAsm2Ql839Kf9vUA6XiH741fk36o4ZMmLBvROxYKRoOeJo/NBPHnxYc1C7UzjNLts+AqWAjUKEzg8CHv3sz/MhUb9aHFK7kgBrMDswEgAAkWXaUwqfiUshEBwFoTOg1Fw8MRPeaVuQ2rzfgB9b/Pw/nS0b/OTw5uam0hVkfQxYdudhdI/fJSp9ruWTbJnUQJWyRYThjH3YabFMwa7MDu8krKgHPR6/UiPaFiMTNn906GdiycxRdg1yWGojGYKPbs8QYI10k7rNtIAVSQZ1n9jncgWqiyBkwU2qjjQdYsG14Viu2QHRr/LwYBoG8ryZXxIBaF0RdOsvp26gpscjfa/ebCRULZEuqDbv6OoFf66QNMIP0o3zz3Ac1L0QFGFaL9D3L19PjcPhM7qcyVdgoClaaVJLyXAW8XsG97+i/xpNFDCJI7AbifZQB1AKAUNAAY7FhCHXo40JTaMeqaj+SKEh9Ezf/egMovAugKE+Qdd2c6fZOUAVf48kShHFK0z7GR4DjufHswm7R9GLWw9fh/ecn5P+L41k8r4RVEQO3SCHW5+iXoESS2AS/jfhGDRAqSftDdoNYTQC3IY2Y0oVsbb/5Th01O/8GA82qEc5nY0VL3MxGSsVLqcqeZiYH+SgNrWEBGRkJjDpJCT9EmX23Zj8hUWAN1ROCf0IvUvKc0kzbLYSdLOZ3KavT6Fk/on9/pXOJYoDhpPYp1PIDBsC5R414lmkSoQzZfsTQgI8YwlSYAhP/p5i8vCT0EX/GoJgUNoJ7gSMSPJLK9DYpg6N+kmXQZE+A+y0RIOhndxIhckgS5zCPDw7s3HEYvQu8qH/SQAlxfFKsQT87KM21lawDFSltVtT7kviuxEwSm9nUUUEpxUidrnnK19RXCFeKcBw8mnGAnQ2LPPiapd/vBgCuqQzDAmVDpW2RjkOJPxKYJDeBKfBEOgqcGUH031vOUaUIScnUmSjQgkw0ls28RWZHjpNxGqz0WgYiywST2ka8RTsbpz8ZsNAT7MBiIn9fy/BMozhsCkFJ0htpyCt4E/i2BE+ZJRqYwgNkGyYCCjQZJdoOKjjAiBio4Q9JiMxKsi80gmGI9okAn/LGV/ev0XML6H3CRsJNi4coRITCA7OVkWFXERygLnQDn4hD7bZLhliZNsLpXmVsAFZQlqtPCbKX0bWhMaWFaCPnXisIltymjXCUERmbOildnpFQ77yJ3Bo1ouL7mQS3pk+HyMCinKZhhH2jlSmROxMmZOJ6qJ9H4G3TQxe/KmNKBnP1op71o8nR1jCH6wZZczHmFb7s7OzPNoTULWUqffU4hEgFkLFY4CM58z9OAeNF4FLmysWHcCPRk5JPmtfFxNKvCyCUiYsGC3YiEsTLBk+VlENdDcpsajEk8smqIZTOzyroyhczMi5DMLMPhUUKf2S2MJNsEF0wQoliB8TNiX+VvjtplBpYzf+HmIJanMNN396m7WT44lCDemhEyORwgsmhpda4OYYOdZ4yhI39jH+Mg+TTFEyYdzAKn9ILW/t2v7f//zfWJkprjpz8QKPnODlyalCrcc6c4Kxy+NIag/GXDWdro7DB1r6rRYrhppobkm+1S95bb4zUfgploX9Fbmm5lKOWSVMbemwWmn1vdU+NxX3NaZNlrWRq0moEgYRkqbMoa9bDMPGvoIwQcPcXGZsqb/5OF9i/hRDugC1KNJBUc/thsAD9win/nwuEzBkF9I0jFY6HKU0PTFe4gpU9rstRVZ73EUcAgW8I9wiSze/eM5EzgpxyK+YRHF0cU0B7uvz01+uTz6oP7tvX6OMu34D/31zcnzaPccPp/Tf7t9tkZfqmqBIfaPI9g2tTgm+tTbqPEWosNea+QDBkpC/FAaydq0IMiP3wYu/vBDZeJLdwu7bpy5fyGvo/yIOnjRuH9LLSJ2+YVG1ObBjm9grMf6Zn3sOTYG0hAcKbFYrRBuPPZcSnKdghidm3s0TnIwUaL/DyeifXL2xCZ2+MRcpv1CEIRKaheJcgMqVFiOIPZTRU2MfyEnxVWlckvhcAnu73IwWKYkwl4QtX9E09v+8f9o/O3kD/1qHR2AndXgGC/cjnxcTXaItQkKqSt5xyeqDg9XH5pHHRYLyFMflVIWrzkKplj3FoUkB+Dsdml721PQyx6ZnnJuXBGZxuRCqhZEQ+JLjsfpwzOG7wQJj7y5m9C91ur2RtygSR6SAz3QzFHO0pdxpUz84Dl2hXWRnFU45Y9ZEn2EKQ9I9hAHQDSFomadW7JB1ah9yrdrYNBqXmALxYmCOlFlY1yRX2+aw9VR1DmeMzOEstddLA6U0UEoDpTRQSgOlNFBKA6U0UEoDpTRQSgOlNFA2NVBK06E0HUrToTQdStOhNB1K06E0HUrToTQdStPhP850yAi8J4xUPFARFM1uF4OeVVsK2vTMtK10+zWNV6VmW5eIVNalSJDO6o3OdcydP2P+Zc2+OC1zqj26g+hbLPQLbiH92fcofdaoxpVdxLWEWVyoMYC+8wMvvHPkFR7JC/QlHZV+qK+8kKKirgZjD7pCILspdUWJbMKZnE4lZIpMdqq8Jcf2k2s04vYBtbezCakKkSjB9jedro9p02N/qFkg/iaXo1dK68L8ScpaB1MiU2tI32dnkzt2H+ucZxzx9FitSV7+9RP1TV1IFrcs5WKJoi18QQ+R0o/LC2JkpzgZWF0v5s4IKNxbyLv4Wozdjf0JVwXVbgLrRs8dVtBJbpljemdyz9y+ig67gE0ASwa9yJICYA+xSRyKO/xGovfpcZXGlPM5725MYhMX+H3vpvIe79CfGhSg75ICyvKsKcR6yz1o7jf223sdb5/vN1ijudfhzeH+PuvsdVqtpr5EQiOaQENnvGs0DpzjkKCYIxrUJVBmN8ZRAApaZDxn0ZzY/p2Ch1G5OtolBTRRol2WzygvNQnDj0CAHwkbBhA3lXULAjw98oSraaD9uknkBciJqI2Xz7wmc3lj2LhPT9vMSAGV1xAS8ZmXUZuYLZf2tdGVfp8n0vu/stpy8vfTXh9Vkqvu+euTSjXRYxJ1QP1ka7JKa6GyBMU0WFHBAPiKXIF9GSR7c2MS3uVxdByKfnIGdDlUXRnC0deVGFhiJa7V/805XsTAzzxRRmulHtXUF3xi/zZn+ORyjy+GV8Pisc8o06nlFb7LamoziC8ECqhsGWbppxKzj8Os8c0VnQu6/Z57u5wco3RvOHsMijHOlD2LyvIHUT/xIblTVAA3ktOoS0g5XsDHYCS5ImTeSHhIa6VGA1riNONjIp/7dMrw5myOC8ow3nU5P7voWs4lJat8V/qOROJPltUMfga96g1qPImNqlGT8gFKGy5rQtHSM4vDOgtrFiiFvbgq9Jilip4591xylgXfugwrsLEJlan9vGxBddgzd07L0m6MpZuWNaKeftMST4rctBzHgt40ZYev3q3MqrK7lVnZ19utnPUcGqUrCu1TkA6f1NbsXCbeItwLv8eGJnEzuaEi7mDumvrC2lXLq2Z1dXp0Id05N4JnObQgPIPW5fWiyMsSSFEEfj26kViyMDpjWG/auEgP/ahJDqJyiSyDI5PO8pE1TPs/H0l7GT8qmT3fOEUmQRLZ1YoSZIiPuusF2C7l5eRdiK5XEnSBPSpM4gX36RshfGs/iNJ1VAuIPxmuLrGb9vKnDtC6k5M9MvkCJ5tssEr2EN57dpffU9Iec6yHhDgsJGq9pDk68TJLfXKRXgDFRUR8Dpp/B7FvIHeN3E/wqkgsoc8v1yIkIhPTT1aJUJUVaZxWo5E1PEx8GTbGE9XyTpPpeneELiEnaz0pb8zyoFrdIb+t7gifsW+EldGpmIXtu0WGl6qrqVJhspE68uahh3YR6Fruf8DFcqteuPCyGnXdKapq1H3LJycZBKJ7FR85HqLuAqvj4y6ErrRRD5uNA8y2Eg3OwsALUw12d5Lfeyxw/hrG3G7R2ktavIwWccwncarFrjlG6FyC9RqmmhjTvFkEPtik9u9tYwigETYLozQcraRJP/x4n56hYfzM/Bn3U5jYfXhPhwqLTOV7ClYEeq0cCTPsnS3W7uOwU3zRIyTZJk+QiKccVj5IvWMK5xAdDFrqyXqqOaE4rEZPRXU5ufGlX1Omrg2xJphdkrXuYMms5NpN0Qs4vplBl+P/kL7izu6+22kduLuNJnxy2e7woOE22812LgOAzQasGbEOfUiSOOlDVcfEl89uOK2zs4wXU4YMj3lU5cSMo+fNZ7qQ1M8F0hKteddV5pBaChLGC2BnyW91O1yNlOYBvThY3g9R4cIy7GzGJTOc9i5q+7ALVJ62RpVtabGRLJJIvBC/pbCOEWe6Y8BTxSwITLCYUHEYVZtIh231uDYZNJr7tcZurdXptxpwLA9b+/VmY+e/KU0w9Ciy95WBpxCOmuuJlxDfI608zQKSn2gVxgrgTCxUzNQRU4pHhCSngZ5sgAXoUDoYxWHlz93LUzjlMsSZzOKO0SGKlUPu6e+5qI2IXziLmSezSBJkqmo/sMLRCIM4jGAZR2Hg/1swGHqvQZeoFvE8AxAFZ52AwdlkyCQOp/jywYT+mt9xuYm/ibX+JvZWheTsjRaQejQ2Ae/OxRtKSRmjHGw8ARW025oKeIADmWRg+mdXVw8j4ZGcftJgdPBJDlxf5efV2h498CBW9ARwyNqZctgUDPllyWTbI4pnz+MrrZA+AhxXDkLxY6XaEn3LWUTVYQEwwo5Ar8STqiMa3gVFsiMvsNkLIzC7NJ64+uSrcY77F7qSoor1nR6T1foPO7qnv8WISgHekoYUxGc9RxSznd0hYx7nOyCKh4MdDgTtthq77YNVIjV/Khnj1gFa4xUOES6lUzGFA1h8TGpuD+ZOwoVXkxHYv1hP5QjTx0ipeQl8pau8CNnNNQNjPmanyqy7D/kZ+0Xw3rX0KFhBPt73Wx226zaZ5zaaHbbXdA8arfawsd/cL473zFRZxB8hrpwTEb7/kB/rzgyj7SaiTCUiuBUSj5cGxK3ev9fLQZX0w0H3yTe2wV6xnhOqyNeEKvoxIbpOgGrU+1TczpiMMrHQp7qeYWSQK52xBTVnezDh782hqeFwH0mn2dnr7Hk7w0EDP+3vD9vegddo7A+L05SeIktLJ7KYdCyqhfOUKy5lzaTzKZLGplCReHHGLNZsO6znxFKXqNPQ75JHUz/WpWUfJeKMtRAos2TMQtJjI63ewMUqrV4cXR6M/IBzlYGjHT4bTePobrkbO+WYoHkxtDKsN1mDrrhqQH/+k+Y9agHV46OfNLvGP44u3tBZSruOCk0qetmzUsY1DjmLgAlM+OgL1C+TJjBhTo9YiCKKHGd7PUvkxA6e5Gar0xFn+qCxuzNstwf7G8hne54cIVF4rx5syWoMXEmxBJ0TnMnotWE718nBJj+x4OvgrGy0nsn0oZHwz9FbEQM0GIzHWRKbJY/B5Bf3777+0ITG+G+rYugVOFUqe1dw+kvB0I6lEKQzmxJMeQIYG3QNybXU3fIkGkuGyJbl7rWK+VWSZySWKhnFE+oy+sP3oUEYPyqKUUQiUvRSZ8ugoLUudbeY4Okrp7Z4ZTRJc5cIVAsXp2+jNy4lovQQag7aw8pXeOzyTzrFuCbnrqm5a2j0Wwc58X9f8SFQ4LheOsn+eCcZ8PRCRo7Y1RfaA+JQz5QIk75typoMI3/kF3Kv6qFFl7wV6jnwBwH2fJGb5VcEbuiaD3gl8ZQIP0TpcX8ij/syh4xR3pvT7Q2Y65UQBPlsU1huyYsRWfmPbEgYUGI7XX/mq5BpuZ3PfDux0j4+VSnfUirinbFEIjACNYS8Emdzgt0mY17DPeD7zfYOd9n+Ad/bZe0Ob7hswNtknQHbDqMC1jY1089aY8RbXHuiFYvbOzIaSJUIDEilxbtcO17HH+9AM8DS42uB/FU2/GPABLsApgVjbS2cXdXSvheIz9OhR9xbRAK4RHcq6LtQzuwcCDYboYDmN+bKd07PsFmER9499aI0Sn22mIcCP2JT8ClQ/G5KIZWTfg+09QEOTzSMmpQYusipSF9RTrpatSv0bN0rR20AzoRqRt4kT6WXZDbfUJtAS9bKlBzf0OWhWd9PFWJQkMvYB/22Quv8hhaxWsP8pgDVkZtSxD53ESuyZ4oxEftOtmLnFpSv/MCPx9yqerSOlG05kXOWCavCXGCTKxl1XCtELmQHJbyEm0rGzLG8Ez0f7YEI8RbQSiJONTaeEZa+c0MQbiBxZMfTYmEsmiPtlTw6/6k7wOdvYfvH1Yvrn0TKGH0SzxfH+PmYT0NyIcJX+C9zpxz/pRid4cYujMCu6qETFHQMWr0Bi/BugIyCMTY9b9ZvSt5mSk8OZwUimjC3rjKg3kNCRULNYA/e9bwN/PFv1R29JaO1W412p73X6ex22s3G3q4tplK7IUh8oyXh/Xh7RibgT+JkJXt+1ux5CYMwIprmei5sBilvOsonIE9TBzT/xB+JjF3NKqGv5ILIAvWx1IkflPok8nyESYFTKdWcnhsLDPPi63DNvlWSIfEeZ6j3YL857OxzBtS732q6bX7Q3tlv8V2y8lwGx2n1Dl/JRL9iTCytdOPCreHiKYvmICr5vKZSCIuw6JLTPgWnLVnkd8IiTWhPTGYnrh6JtsU1HqmBUQqjroWxTEk0dEnpRlE6quaQX4flXafJJo/rIUnUj8OSsXwDKlwy4hs08XPC6Eg8yUpR+t4xw/sl8isSAdtn0YiXTu7vgH/lWOBLAFzqiC5QA+MdaHYBDBpG5Kd+77y7CRznM/7HcW4qbujxm8ohfFoEWAZrFPj/5t6Hj/w+xppGspX481D0FV+Js3xTEd+8103xMik1Tb6a8jhmIznNtTGNA+P+EP9IRbFo5YfOCzHuCzHww03w3vlBstRT79Dp8ANv1xt2ageD5qC2s+cdwKdhs+a5bdbaP2i3Dg74j0LOF4wcUqUnaptiqYqTW9gcMn8iXRw+XufK59lr3BylFvIdneKHzC9ZbbMAGYrh0K66DSe3ZpaIHdeypZRhScxhyqrD/IiuH9Rud6qOysM4D+/y16Ci5mb+lJlsk5NXZGbilHlTZd5U8byp7yGJprxp9jxvmmEs0yiSumEO7/KbNl28B7rJBYVUUvUX3E4QMpsvGS/DOwe7/IDvDgf7oBdw7jZZa7A73Bt0NriscGygodjcF8e92s9XtdRVhpiPil1j6MmGorYEqQvAsDYwrNfJlUGjcQCIadcGnV2vttMEbXJ/r92puYNOu8VZYwCCZhlUsGStPRVUkvoY8pfdVwxrk1ua46r+BiY3z/6Ol2J2RQ3qJ7rgmMr0N4YslOpP99Feh7ccdbOnAoIGdUZy1GJwPON81m/gvoZQMzan3KRkDIATiqsH+ipTGrLVBN1+HjcdDJFh6em3+Rr6bambl7r5prr5c2ZmpVL+fJXyondpzg2XkVggwxIJibIkzjBbwClHHgF8IJX5L2BclZuUw0fllWzyQiEe34lv8bQZpaY2ul/jBx7/JO7U0EJqxKN+FFk1zsSPKcmK69ljhXM/cqYgnjGHN3Xb/x+9/smbD0cX569OX0ukhgVyQ02cUhch4kY8wGCEjPwTIKn57mMKsqHwVKGI4jOJPlWHikjIjP2qtbWpDCgGjLDe9dg0ltdY3I/FnLo0GBom2MUedD57VI554iYVbw2pjUptyG57uH/Q5A2wJIY7rrs/GDYPdvebOzusyfd2dhpUU2IGEimSlRjXrIUwBuc8FoWJTi9RaGFfe9pOqw7/O9ir73fI3uVzoMQC40tD8lZdkKZu9tB77cFuxxsOuNfc32l1drBmxd5Ou8Wa++7+zqBhBRoL1JnT8bOsv1OTQP77Ail/+ufKLPRoaaNGuwZsl8Vz1KvCaITanEtiRFimsppXD1Z3icdTxOwIvgIJhaKdwX+AzY1BB+SiPl7uJfq8VwKv+z9jYZGjbv/04lyGDWXsb4OAKB0fwTurRp68TI5fcpKuTn65Pun1KxvERgS7kxepMmywR98/HSeM5Xj5zFD9upYfXnZ7vZNjUWPeHQdgu0wKOn3kEQhQF5lQfIpMcFHeMPWteh5mGE4m4Z2gjBmcATAgEeYXkrI+6O39IBbwor6CID7IPfqg1mAbArcpE0ArhBld+TRRFUtDoDQETEOgjDc+VW3B1Q7lFKy/1Alc+0RLj+pXmdVUnDIiXxJQ1tmIpYKjeF6MYRrDUK+8YhcIBQ6LYZmNR6VYTp7XXWqDBatbGSPOIh8rGItCV/l6lIG4pNyVx6dhXabTP2dj+TsIws3GYbAZGVGP3Fugf246oJDXOq29Wnt3r1W6E563O8EPSOA+Pjahy/fRg0hisEIObWDSoG3Ov8Chbk6tRys0d1Ft3jgRMuEJ0KjtIftgXJ9fnbw+7fVProQqzWUIr7CpnMyluuYewCZrsba3I+5AsoCNipSFNAaXffJYzGNDqn7u6BnFZ3fPG/Ldgx2MEfJWY5+39txGZ+9gg0pRyi+ybsYufOux+lUoXmfYKJKdDtpuNBeqRn78JrMvj6dspmZFWMRTmUlEx4IkHSq6TKptF6YOPbOqs11Qy80fcEWVyfbA3Wdea3ewv7u7c7DTgX8GoAO3D7zmcLjnrbR91k6WVYB+vnLSMfWC+QcmD/ji5AM/b7DfI/NgzcT5aQebOKjesBm6WICayVYEhRFm/cjvt8XrfDMG6u4GTiqy/OjdjGvxGgcoy/L1DqEgy7B2T3LyFPsV8gUNTEAOttlQ/dF9ie/zInV3kj7HiR+xyAyG/zA9xxrD5tuvNbCiipJR/CpwLgU6RIY37PvyKLfu1sgEqpWzux8xd82U/5saUr0T/l8kSUXC9ZpestV/WRbwZWbjk8s06/2kZ9Jlpzo4LI5D1yd1TqeamNWctc+0dEs8kVviCW6dm/eHykT17yVRnRTHL66RTwTjk99ofVl8pcNNQvfj00wrRipokn1xkpMx8YYJTkBHZLMehZEsJ/HFQGClZEo9UmM7rh5cPD5vcdb1+AHefBdG3hmL5738MO43JXsNR3l3pSqXhvqrqnbT0MMADwbcxW/0NIxWeaJFPP8w4bccC3LurCtJ9I27D/Nq/euXlSWZbp7RV1hXWJ3Jx2azDfST5Em12LZRl5dGL+XfE8m/5bZqiUgLkTpm+EhUZeHS3j4jzUdjJA+5benlOiAvV3PY9vZdb9fbOTDAK1qqg2l105jdqkJox2HOfyLj2KFQTPHiR1bMRldBSr1U0p3NBNeazZZzrAzDWcrCirMTvb6WQKCdArTWqlJPAxG39EdBkoGca1Wte9uOprWetuseHZ30eh8ury5enZ6dZK1+ijiQI08+BlrofbtK/ut2JUt91rHopYaMTIoAWrq4Pu9/OLq4ujo5ExkuMk2xmiY0/YVKgelewk9vu2fiFxwHP11enqnkqWrlqPvmsnv62vz4AQbrn1zhNydX/dNXRuOz65785eL8/OSof3H1oXf088mbLnxlPlxcrby+eHtydd49Pzr58Prq4voSvtLvQSUfDdD1VyrHqlo5O311cvSPo7OTD71+t4+NMKfn14ur4w+XF7AGHOnqgnpfXdM/vQvjp97F9dURftvvvhb//QArOXl9cfUP+rP3N5ird32GU12dXF5c9ZO/caC3pxdnauVqG7pH/dO3Yg0Ax9/E0t5ndPOA3h5SBSlU2ialosIfx/2L2MiwQUVNBuOM28b4OmoEZkW0cDGPxvYuGKjUtDcPReJKCpj1Fkn6Zr1t/i57iKrURx6nj5TFP58H465E/DZ0l97S06PSm4HLn1Xpyee+H2wGmZOQpy3zBIpS4j9DwiklfinxS4lfciEtSNY40TNO5ZUv5iWgF3oDz3IFvFzc8wjN/ddUH6q44U9h1MBjEztrcOkalotDQ8zhsHSWM7KQSoWWsq+UfaXsK2Xftyj7ShvuebCjVdH6NRbeChkmKlnTvcOAy+0vHbz/qTRWirxS5P0HiLzS3CsdvN8X435yB2/p0v1eSaWU8aWML2V8yYVKl+5al27pyy2FXin0SqH3bIReaa49D3b0NX25xq+KjhX96Azjp0hxLpp7rFHUse/sPAEMxmgFYWg2HkQBrSeYHYcpOq3GvNyqp9sA6XDfABBgEoWev0u218pgx+4blNzPPniz4Stz/+ksyj41JSK/BJHWGSxR+SWoJO5XYvBLiDH/gmKJwKIIFM9zMPhTOAxKZH4BModgMgyY+7E7w8dFl1R3SvtRjBfHUal4kNrFU6uXufqHpVc+g2c7lDJuFuylUq7rUwbTxFsW6i0L9ZbM7PE2/WrHzFJDiKrh699sVxDdZ8ZKD2QWllVh//CqsGXZ1mdatvXLqaDd1lTAgy8ucKROPz0Lp0WVHHhlYR1KtniaN/JMOFygggFX7+SlYEj5km0QjsIp+RCutP7wCHBcOYjDIgEEjkT0LWehh9dUjQPU3ADoQgWItPc6zb5tkC6wmVHMM1uxclk0J3+c4/6FeNfH0Aq0Z98S3/rbh2qhChtpSDOF1YQoZju7Q8Y8zndAFA8HOxwI2m01dtsblI5VUy1/mrQnlKsNyqSrMam5PRhVp6xJfe0v1sMemdIasjBQsQjGWg9NrnTWTlA/cCcLzywY9MQvhIodA62JdmxvT+zYsDHYbe809lhWrbEhfMQjofSkrCMRuHb01W+FWuGCrEfsUbWaCuJ/9Tui36b9Vj5N+4yfpl3jNF+a3vgETGTM4kseTf04xgJAjxb6xgqobtAsGbOQPN3IzjEwsMrOOaKHcXkw8gPO1YlamRG0dBpHd8utaV0of2jVGqhTCvrzn8QCTpIFWGlF+MfRxRs6+u4YBN+mk4pe9qz0OFyBTKtNaeIxz+xuup58jWV/p7PX2W+2Op1GEz8dNHZ3hu32YH8DjcWeJ+elmMJ7leI6Vg5X0ZhzoRDzY6Rb21aG0LeXeHVW3bt6E4J+DfoUjDLnhe5cOU5lSWaA5UfKrfnbTfxdqXKx6pcVY5xYnjDV3/h2Vd/bVK/b1e1Psy60HM/qEpdq/i4Y29MjS9TeII2PxPt3xWM8Z/Qr/zTfduNbinVrlpGCWbiwtnBPZvND1WXLGXNQIiM8yPGMu+QG0cb0luFtROfgljNjEZySOXYIpE+MDC5nEHr0mMJWr3t6dnlxet7fqqLLlCzHZBRoj2AD9U4mwoIUdYLx7VTmHPXeardr/SbIc5kmipN+leAslGXuqkfSSfoGVA13XG2hH/FltIhjPomrrV34qwfDMDAYeLWFR6QffrwPq60GfmT+jPvVJrY6CwMvDKq7O/BZFvhrNg6wOwudS+Bv0GeH/gycv4bA5lp7puaW2aUabg5tpMA2yeO/1/rhnE1qmiFkfZFzbKBQJgoV/qAxFgYTwLjcVvrR2h5rP2Ff0Azf+hEZRUaqKBZkKqYdAnen0chCdjTBB1KdkygCg7vmXCmA/GEuRfgBSEGfhIMbwkxisUZ5wu1/xkI7yAC21HmKVeCPQq8Ai38FfLs2ipiPEHIC2YWOyLBufQ9dUVNkcmJI/eYrtrNFAWCi3nReMs+5kus7kot5SB5tLVJ18lpowaoLGObkuFgyLd/jbLDbOGjtDHd3GGvt7zT3OoODIWu3Gwcd8bCLrJm/XsN8jRUufRcLVstXIyPOAPcEAE1eXL+kMQrgH8lYtNXLlPA6yIOqcOpfHl06O3vOhAWjBX3PRikkBDV6o8J2yj1UJRAXkT/yc9VL5Uo5PnnVVdmdMqUUx8rL1vSFyhOS5B2HdwSxXAB6W4GViFeQnC056ha9+RmbDX3xl3ge15EqEfSQs+f0MId2hlE4tY4SnZtPcPj9Oq9XgW+iz5rN3bGDDlNkBSZzr51JTCrm/mPd+cLIVbIXCSozT2lI7ndmboqUTkViHOiZJZqwTqGmFgmi3B+AWWAuGwJRSCOU3oswmpvUJneBM8HafNClJDsiXgmMJ1DtNMcyRS+xuzcCmON5KMpmM3z9de25u5wA+6nR0vQPt1wePnJVCm5Eu6G2SXIkFb/AzrKV3i518B1g8hOvPLvl2S3PbsGzm/4R9LQZnEX1K6k+zazqcx2wBeA3IuGZUX1EgCwIHdVIqLxiI+l9bKki/fXXPhzsjzzA9vzTDMMXT6gfCVGeAb6r90N8P1DZD0r0GxFyAJDwKFYwBE7EvUOCO4FYeNkJVe3sbK/CaOADgQY5KiJwzci5DxcifrMI6MFyFldB+edx8EI6V3WNauiDswZebaZeBSw1yVKTLKVRKY2+D2lUapLl2S3P7vM8uys1SQ0VnRapJ8kaZoLS5O/kTXegAXr7qL+jj5yOPJnaCg7maB2rYmsOlUGrOWgO91y+47Edb7d9MGy5uy3W2WvuNQc7LYzSJrL+XXKO9SGzz5Sx32IfCcWgxN2CHrcI0KM5D0PPdv8BeiM+RLZGyThKbwacA0rfa92xdZDj+wxD5w0L7pWGFFs6ZJDgCHkatJ1iW536Aw2YMwK+GGC40ge4kJQwL6zm4AMvjnzIru7gKq7wNcxad4hOU+ULV65tOYuMucTECSahSMq7Yz4msw1R54MRSIMdAXd+Qu3UeDLz0Zq8c4UrPsMVOyefXM7xoGvNvZPn3z0F4CPkET2xwUscvUk6YAAGgeBZWu8s9fNSPy9lfCnjvw8ZX+rn5dktz+7zPLsb6OdSG1qun0ODwvo5tK03HK1LvaKsqN9bTaejIiEg8nZCly4QeIkOTnoFkBICNAtjYiJsPoa/tsWliG2Vv4HpK0LpF+AsInxBdjyfz+LD7e3PsEuwOw91NvPrKt08CO8wIXv7Nu9KlyjqjPQCXMtb0OO3eANDWhZ1wm3kI/kKXkcTCEzLLLOKTsVaOb66xXUfLoC70TBVTLiXpERfY54T2BE6EQwxk1kjrO06mjysW8/b9qp1iEGWrCMPfSvngvYOQJlanrz5GXPYbhiohwq3mP0aoDoSrKq7wH1OhAgaadkbsRfYrOW8BGLADECKW/zw11/7P5oPdsao4XKfkgSZcwkkQmysq3z42IkkSxQuRiJxrWtFSfDYOMMJLNi5CXqcO+/MEkhXwJAJpdiJEw/AXu9/UDvj4XvGKPrq1k2Abd8LtgFD28zq9yOJObIH/EAkzmGa6U1Qc4595D6YTkRt5BLJvHPezdS6mLGuxwLxJzVaTYxWo9HiH1NQCNS+c0XWjQtnF4dgk5iw9ejJxXg1Yzw0nuAbHDUNg7g6RnDYsS1X7dqj4bDGq+F4Nhw3wa90sczu5giW5cQgAieec+q44zCM+f9xHCQdPAbvRgs4RY8Gi26z1ehE1FoNA6SamLLm10AjJPjO4GAEgpjYACUyKSQh6GqBJ47kb7SzcOZ/o9S636w109fvQHBiSy9040fDjBPWcMKa4AGxhF/IJSQsONu4BuIDggCOkv0nTiABNXieGCuXq9Pw29SH8soAVFFwZ3Yo/jhMGJz85NAP2Fq3ARaMCrWO9sHfjhyLroeYyFKugDQGs/BOQpCJKbwJeLUrCuXkt7ZeXHE38ZhcBJP7p+bSSzjJt8N3/yCOV3Ka75HTSBUXPY/Sn/cy9O5PlDHyuUK2CinYqjYCGs+gO0Hj6L4vDp3Oaq7I79+C7BYHr1NvqS9xOPmBbiAcsi3EA9rsND7dSqBE4Sn/byoUW5Gvhm8fARWwUYimfQDH9Wd/bg4mKpjVacybm5sKJcRzeWbC6B6/q+hsaZbU2qMBjmNSNskWxQ/icoRRLUPaf7+oNYDFMCWA0VL718J3PzqDKLxD9+EnmKbd3Gl2DnDVlPacrM+sVIhXPGeT8J5zcZOhYha9e18V0HSDe31TBO085uNdJek3wNV00Tb+JY3bX8Poo0KsjR20eOlGct9CBU736eQT6PfyOlSzAVSEIgA+4Ue8lQqtY7ci/nh5/1ZYdRIWGQI4p7GVLU3giAzvV/5kLi4Oq2CB3u+qhRa6zJu0iMHw/Yg2IfzyYFX3kAs47mHNVuP7OE155m9ip+2B6JwEEnC9+VSzJUUvZAgCNRrNpP6OoDsqu172UlVk1S78RQwjtgGr+WiUyLHMC27JMP2TqzfGKHIQ+lGb1lZFWRh6sHA/8rkxdPYugD1Bz5xBXfmK6664xGEQwtQPjkNXpuS38ArWYmCk85eoLFH5x6OSBJpgWWme+2fAIJn96LihoCa2MQrerCm01BQMHXGEfOOBWN8wJKGQuuqE6qHwc2QjXzEVDIH/wq+k45IXimHFEnVtzRwGFjBHbVBUbRj7nHzmM86oYkUVNbJwShrsLApxJ7i8ijui0jMRiHo2YQN/gqUYnF/xiqILMgEdkphlCKP+M5SeyR7oJ5eo3jjHSuVxsCbFIsCNAiAWUwdvd6/RiwDr7kKo7yC3Aq5WFpIDRPdSuiwqXIgKqgKFwvViiMFVH18HqBScC7SfWEZWAZEGmSULueITTWe242rd2KBz1cZ8QldEwfbgQcyNGd6c9jMjwmCBFLxhNNqWneJtbIvXZbWUatcb9QZdPQ3j+ZQFxriXPKJtZ4649OaQpHe6Vo2r1BViHVlWvanUjOhOAtm6boZKsLgxJZ1lmatodeflvXL+V4lcsLjJDGmHOaA1+FOgiHDogMbQaDTUTPJOFqhfYeTFdcfph6LPDOsJybby12RUrL5jHE3sAdQBval0FBLTu0v8SvibDJyARlpcVxcPEURezQ0nE2FT1fTFsPhPMz1DTcBS+5eYId84sy0NH7Vmuvmbt46EvdH9whlGw3DnF8LbKdzK7yR3MlQXUovG6HuGXz9/xnAJelkftBYu7qbqgtVSY1xKGRfDYcznogqSiJhM9DU6+KHuXMeiDFByRY5O7xZlhmxRnE5giVseSzEE1oIjQ1l6eXsS38BHFL6dS43vp9q3JabzMpR/5Kgoh4QIQ2SJe6mFEfmGfXKCpNq0WD6iR5yp54MI2tjH4+F0KC9QOr68uzoLZ4uJoA/ubFl3ObeSGJFMKNJCLweXWEvkjlwL5nVYf6iJEVnYltjILeeO0m5GQYghHHQJ9MDe0NE04aUWt0bFdVHkOiKZHnOhCFvYHo4xw5pdPoXVkE9hQSWMMQYh1eWKOc4qrpX+RCvfEmk/AC3hUGABWw8on19C8zyoQRVTTKjhfRKiAV7zXt/UJcYjOsksoFrfVgIz6U1IWaKHCPSubPveCL5dXtBbF3hvlsx1EUeM2B2azvDfw8pNhcz8cKbtOvr+c0VF5dGqp3GV4zTPbyg/4DIfHv4/weMOmg==
sidebar_class_name: "post api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Perform a Search Query Aggregation' (search-aggregate)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Perform a Search Query Aggregation</h1>

<MethodEndpoint method={"post"} path={"/search/aggregate"}></MethodEndpoint>



Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records.  To page past 10,000 records, you can use searchAfter paging.  Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. 

## Request

<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":"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":"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":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"indices"} required={false} schemaName={"Index[]"} qualifierMessage={"**Possible values:** [`accessprofiles`, `accountactivities`, `entitlements`, `events`, `identities`, `roles`, `*`]"} schema={{"description":"The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.","externalDocs":{"description":"Learn more about search indices here.","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html"},"type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities","title":"Index"},"example":["identities"]}}></SchemaItem><SchemaItem collapsible={false} name={"queryType"} required={false} schemaName={"QueryType"} qualifierMessage={"**Possible values:** [`DSL`, `SAILPOINT`, `TEXT`, `TYPEAHEAD`]"} schema={{"description":"The type of query to use.  By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body.\nTo use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly.\nAdditional values may be added in the future without notice.","type":"string","enum":["DSL","SAILPOINT","TEXT","TYPEAHEAD"],"default":"SAILPOINT","example":"SAILPOINT","title":"QueryType"}}></SchemaItem><SchemaItem collapsible={false} name={"queryVersion"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2","title":"ElasticVersion"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>query</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Query parameters used to construct an Elasticsearch query object.

</div><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"name:a*"}}></SchemaItem><SchemaItem collapsible={false} name={"fields"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields the query will be applied to.  Fields provide you with a simple way to add additional fields to search, without making the query too complicated.  For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\".  The response will include all results matching the \"a*\" query found in those three fields. \nA field's availability depends on the indices being searched.  For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn't use \"firstName\" with a search on \"access profiles\".  Refer to the response schema for the respective lists of available fields. ","type":"array","items":{"type":"string"},"example":["name"]}}></SchemaItem><SchemaItem collapsible={false} name={"timeZone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The time zone to be applied to any range query related to dates.","type":"string","example":"America/Chicago"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>innerHit</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The innerHit query object returns a flattened list of results for the specified nested type.

</div><SchemaItem collapsible={false} name={"query"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"source.name:\\\"Active Directory\\\""}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The nested type to use in the inner hits query.  The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps.","type":"string","example":"access"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"queryDsl"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax.","type":"object","example":{"match":{"name":"john.doe"}}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>textQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Query parameters used to construct an Elasticsearch text query object.

</div><SchemaItem collapsible={false} name={"terms"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Words or characters that specify a particular thing to be searched for.","type":"array","items":{"type":"string"},"example":["The quick brown fox","3141592","7"]}}></SchemaItem><SchemaItem collapsible={false} name={"fields"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields to be searched.","type":"array","items":{"type":"string"},"example":["displayName","employeeNumber","roleCount"]}}></SchemaItem><SchemaItem collapsible={false} name={"matchAny"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates that at least one of the terms must be found in the specified fields;  otherwise, all terms must be found.","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"contains"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates that the terms can be located anywhere in the specified fields;  otherwise, the fields must begin with the terms.","type":"boolean","default":false,"example":true}}></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"}>typeAheadQuery</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Query parameters used to construct an Elasticsearch type ahead query object.  The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." 

</div><SchemaItem collapsible={false} name={"query"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The type ahead query string used to construct a phrase prefix match query.","type":"string","example":"Work"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field on which to perform the type ahead search.","type":"string","example":"source.name"}}></SchemaItem><SchemaItem collapsible={false} name={"nestedType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The nested type.","type":"string","example":"access"}}></SchemaItem><SchemaItem collapsible={false} name={"maxExpansions"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1` and `<= 1000`"} schema={{"description":"The number of suffixes the last term will be expanded into.\nInfluences the performance of the query and the number results returned.\nValid values: 1 to 1000.","type":"integer","format":"int32","minimum":1,"maximum":1000,"default":10,"example":10}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"description":"The max amount of records the search will return.","type":"integer","format":"int32","minimum":1,"default":100,"example":100}}></SchemaItem><SchemaItem collapsible={false} name={"sort"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The sort order of the returned records.","type":"string","default":"desc","example":"asc"}}></SchemaItem><SchemaItem collapsible={false} name={"sortByValue"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"The flag that defines the sort type, by count or value.","type":"boolean","default":false,"example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"includeNested"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whether nested objects from returned search results should be included.","type":"boolean","default":true,"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"}>queryResultFilter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents.

</div><SchemaItem collapsible={false} name={"includes"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of field names to include in the result documents.","type":"array","items":{"type":"string"},"example":["name","displayName"]}}></SchemaItem><SchemaItem collapsible={false} name={"excludes"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of field names to exclude from the result documents.","type":"array","items":{"type":"string"},"example":["stacktrace"]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"aggregationType"} required={false} schemaName={"AggregationType"} qualifierMessage={"**Possible values:** [`DSL`, `SAILPOINT`]"} schema={{"description":"Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results.\n\nAdditional values may be added in the future without notice.\n","type":"string","enum":["DSL","SAILPOINT"],"default":"DSL","example":"DSL","title":"AggregationType"}}></SchemaItem><SchemaItem collapsible={false} name={"aggregationsVersion"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"The current Elasticserver version.","type":"string","default":"5.2","example":"5.2","title":"ElasticVersion"}}></SchemaItem><SchemaItem collapsible={false} name={"aggregationsDsl"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax.","type":"object","example":{}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>aggregations</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The nested aggregation object.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The type of the nested object.","type":"string","example":"access"}}></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"}>metric</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The calculation done on the results of the query

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"MetricType"} qualifierMessage={"**Possible values:** [`COUNT`, `UNIQUE_COUNT`, `AVG`, `SUM`, `MEDIAN`, `MIN`, `MAX`]"} schema={{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT","title":"MetricType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}></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"}>filter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An additional filter to constrain the results of the search query.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"SearchFilterType"} qualifierMessage={"**Possible values:** [`TERM`]"} schema={{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM","title":"SearchFilterType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}></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"}>bucket</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The bucket to group the results of the aggregation query by.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"BucketType"} qualifierMessage={"**Possible values:** [`TERMS`]"} schema={{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS","title":"BucketType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100}}></SchemaItem><SchemaItem collapsible={false} name={"minDocCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}></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"}>subAggregation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Aggregation to be performed on the result of the parent bucket aggregation.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The nested aggregation object.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The type of the nested object.","type":"string","example":"access"}}></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"}>metric</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The calculation done on the results of the query

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"MetricType"} qualifierMessage={"**Possible values:** [`COUNT`, `UNIQUE_COUNT`, `AVG`, `SUM`, `MEDIAN`, `MIN`, `MAX`]"} schema={{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT","title":"MetricType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}></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"}>filter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An additional filter to constrain the results of the search query.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"SearchFilterType"} qualifierMessage={"**Possible values:** [`TERM`]"} schema={{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM","title":"SearchFilterType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}></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"}>bucket</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The bucket to group the results of the aggregation query by.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"BucketType"} qualifierMessage={"**Possible values:** [`TERMS`]"} schema={{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS","title":"BucketType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100}}></SchemaItem><SchemaItem collapsible={false} name={"minDocCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}></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"}>subAggregation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Aggregation to be performed on the result of the parent bucket aggregation.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nested</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The nested aggregation object.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the nested aggregate to be included in the result.","type":"string","example":"id"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The type of the nested object.","type":"string","example":"access"}}></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"}>metric</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The calculation done on the results of the query

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the metric aggregate to be included in the result.\nIf the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.","type":"string","example":"Access Name Count"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"MetricType"} qualifierMessage={"**Possible values:** [`COUNT`, `UNIQUE_COUNT`, `AVG`, `SUM`, `MEDIAN`, `MIN`, `MAX`]"} schema={{"description":"Enum representing the currently supported metric aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["COUNT","UNIQUE_COUNT","AVG","SUM","MEDIAN","MIN","MAX"],"default":"UNIQUE_COUNT","example":"COUNT","title":"MetricType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field the calculation is performed on.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"@access.name"}}></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"}>filter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An additional filter to constrain the results of the search query.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the filter aggregate to be included in the result.","type":"string","example":"Entitlements"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"SearchFilterType"} qualifierMessage={"**Possible values:** [`TERM`]"} schema={{"description":"Enum representing the currently supported filter aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERM"],"default":"TERM","example":"TERM","title":"SearchFilterType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search field to apply the filter to.\n\nPrefix the field name with '@' to reference a nested object.\n","type":"string","example":"access.type"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value to filter on.","type":"string","example":"ENTITLEMENT"}}></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"}>bucket</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The bucket to group the results of the aggregation query by.

</div><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the bucket aggregate to be included in the result.","type":"string","example":"Identity Locations"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"BucketType"} qualifierMessage={"**Possible values:** [`TERMS`]"} schema={{"description":"Enum representing the currently supported bucket aggregation types.\nAdditional values may be added in the future without notice.","type":"string","enum":["TERMS"],"default":"TERMS","example":"TERMS","title":"BucketType"}}></SchemaItem><SchemaItem collapsible={false} name={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The field to bucket on.\nPrefix the field name with '@' to reference a nested object.","type":"string","example":"attributes.city"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Maximum number of buckets to include.","type":"integer","format":"int32","example":100}}></SchemaItem><SchemaItem collapsible={false} name={"minDocCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Minimum number of documents a bucket should have.","type":"integer","format":"int32","example":2}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sort"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields to be used to sort the search results. Use + or - to specify the sort direction.","type":"array","items":{"type":"string"},"example":["displayName","+id"]}}></SchemaItem><SchemaItem collapsible={false} name={"searchAfter"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Used to begin the search window at the values specified.\nThis parameter consists of the last values of the sorted fields in the current record set.\nThis is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value.\nIt is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging.\nFor example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. \nIf the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity.\nThe searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"]","type":"array","items":{"type":"string"},"example":["John Doe","2c91808375d8e80a0175e1f88a575221"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>filters</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The filters to be applied for each filtered field name.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> Filter</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"FilterType"} qualifierMessage={"**Possible values:** [`EXISTS`, `RANGE`, `TERMS`]"} schema={{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE","title":"FilterType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>range</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The range of values to be filtered.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lower</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The lower bound of the range.

</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>upper</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The upper bound of the range.

</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"terms"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}}}></SchemaItem><SchemaItem collapsible={false} name={"exclude"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Aggregation results.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Total-Count</strong><span style={{"opacity":"0.6"}}> integer</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>Example: 5

The total result count (returned only if the *count* parameter is specified as *true*).

</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"aggregations"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run.\n\nSee Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information.\n","example":{"Identity Locations":{"buckets":[{"key":"Austin","doc_count":109},{"key":"London","doc_count":64},{"key":"San Jose","doc_count":27},{"key":"Brussels","doc_count":26},{"key":"Sao Paulo","doc_count":24},{"key":"Munich","doc_count":23},{"key":"Singapore","doc_count":22},{"key":"Tokyo","doc_count":20},{"key":"Taipei","doc_count":16}]}}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>hits</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The results of the aggregation search query.


</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessProfileDocument"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item's description.","example":"The admin role"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was last modified.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"synced"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  \nThis date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. \nThere may be some delay between the `synced` time and the time when the updated data is actually available in the search API. ","nullable":true,"format":"date-time","example":"2018-06-25T20:22:33.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the access item is currently enabled.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the access item can be requested.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether comments are required for requests to access the item.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Owner's identity.

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's email.","example":"cloud-support@sailpoint.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Access profile's document type. \nThis enum represents the currently supported document types.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"accessprofile"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Access profile's source.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source's ID.","example":"ff8081815757d4fb0157588f3d9d008f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source's name.","example":"Employees"}}></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"}}>

Entitlements the access profile 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={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement has permissions.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's description.","example":"Cloud engineering"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement attribute's name.","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's value.","example":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}}></SchemaItem><SchemaItem collapsible={false} name={"schema"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's schema.","example":"group"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement is privileged.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's ID.","example":"2c918084575812550157589064f33b89"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's name.","example":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of entitlements.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags that have been applied to the object.","example":["TAG_1","TAG_2"],"title":"Tags","items":{"type":"string"}}}></SchemaItem></TabItem><TabItem label={"AccountActivityDocument"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"john.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"DocumentType"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity","title":"DocumentType"}}></SchemaItem><SchemaItem collapsible={false} name={"action"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of action performed in the activity.","externalDocs":{"description":"Learn more about account activity action types","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data"},"example":"Identity Refresh."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was last modified.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"stage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Activity's current stage.","example":"Completed"}}></SchemaItem><SchemaItem collapsible={false} name={"origin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Activity's origin.","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Activity's current status.","example":"Complete"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requester</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></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"}>recipient</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Account activity's tracking number.","example":"61aad0c9e8134eca89e76a35e0cabe3f"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Errors provided by the source while completing account actions.","nullable":true,"example":null,"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"warnings"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Warnings provided by the source while completing account actions.","nullable":true,"example":null,"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvals</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Approvals performed on an item during activity.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>comments</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The comment text","example":"This request was autoapproved by our automated ETS subscriber."}}></SchemaItem><SchemaItem collapsible={false} name={"commenter"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the commenter","example":"Automated AR Approval"}}></SchemaItem><SchemaItem collapsible={false} name={"date"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","title":"DateTime"}}></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","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"result"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The result of the approval","example":"Finished"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null}}></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"}>originalRequests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Original actions that triggered all individual source actions related to the account action.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Account ID.","example":"CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeRequests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attribute changes requested for account.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute name.","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"op"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operation to perform on attribute.","example":"Add"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of attribute.","example":"3203537556531076"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"op"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operation used.","example":"add"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Account's source.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>expansionItems</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Controls that translated the attribute requests into actual provisioning actions on the source.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the account","example":"2c91808981f58ea601821c3e93482e6f"}}></SchemaItem><SchemaItem collapsible={false} name={"cause"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the item","example":"smartsheet-role"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeRequests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute name.","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"op"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operation to perform on attribute.","example":"Add"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of attribute.","example":"3203537556531076"}}></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"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accountRequests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Account data for each individual source action triggered by the original requests.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique ID of the account","example":"John.Doe"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributeRequests</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute name.","example":"groups"}}></SchemaItem><SchemaItem collapsible={false} name={"op"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operation to perform on attribute.","example":"Add"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of attribute.","example":"3203537556531076"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"op"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Modify","description":"The operation that was performed"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningTarget</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></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"}>result</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","example":"[ConnectorError] [\n  {\n    \"code\": \"unrecognized_keys\",\n    \"keys\": [\n      \"groups\"\n    ],\n    \"path\": [],\n    \"message\": \"Unrecognized key(s) in object: 'groups'\"\n  }\n] (requestId: 5e9d6df5-9b1b-47d9-9bf1-dc3a2893299e)"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The status of the account request","example":"failed"}}></SchemaItem><SchemaItem collapsible={false} name={"ticketId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null}}></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"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></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={"sources"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Sources involved in the account activity.","example":"smartsheet-test, airtable-v4, IdentityNow"}}></SchemaItem></TabItem><TabItem label={"EntitlementDocument"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"john.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"DocumentType"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity","title":"DocumentType"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was last modified.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"synced"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  \nThis date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. \nThere may be some delay between the `synced` time and the time when the updated data is actually available in the search API. "}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's display name.","example":"Admin"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Entitlement's source.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of entitlement's source.","example":"2c91808b6e9e6fb8016eec1a2b6f7b5f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of entitlement's source.","example":"ODS-HR-Employees"}}></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"}>segments</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Segments with the 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","example":"b009b6e3-b56d-41d9-8735-cb532ea0b017","description":"Segment's unique ID."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Test Segment","description":"Segment's display name."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segmentCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of segments with the role.","format":"int32","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement is requestable.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement is cloud governed.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement is privileged.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of identities who have access to the entitlement.","format":"int32","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags that have been applied to the object.","example":["TAG_1","TAG_2"],"title":"Tags","items":{"type":"string"}}}></SchemaItem></TabItem><TabItem label={"EventDocument"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808375d8e80a0175e1f88a575222"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"john.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"DocumentType"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity","title":"DocumentType"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"synced"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  \nThis date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. \nThere may be some delay between the `synced` time and the time when the updated data is actually available in the search API. "}}></SchemaItem><SchemaItem collapsible={false} name={"action"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the event as it's displayed in audit reports.","example":"update"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings.","example":"SYSTEM_CONFIG"}}></SchemaItem><SchemaItem collapsible={false} name={"actor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the actor that generated the event.","example":"System"}}></SchemaItem><SchemaItem collapsible={false} name={"target"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the target, or recipient, of the event.","example":"Carol.Adams"}}></SchemaItem><SchemaItem collapsible={false} name={"stack"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The event's stack.","example":"tpe"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the group of events.","example":"63f891e0735f4cc8bf1968144a1e7440"}}></SchemaItem><SchemaItem collapsible={false} name={"ipAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Target system's IP address.","example":"52.52.97.85"}}></SchemaItem><SchemaItem collapsible={false} name={"details"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of event's details.","example":"73b65dfbed1842548c207432a18c84b0"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attributes involved in the event.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Attributes involved in the event.","example":{"pod":"stg03-useast1","org":"acme","sourceName":"SailPoint"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"objects"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Objects the event is happening to.","items":{"type":"string","example":"AUTHENTICATION"}}}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operation, or action, performed during the event.","example":"REQUEST"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings.","example":"PASSED"}}></SchemaItem><SchemaItem collapsible={false} name={"technicalName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'.","example":"AUTHENTICATION_REQUEST_PASSED"}}></SchemaItem></TabItem><TabItem label={"IdentityDocument"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"DocumentType"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity","title":"DocumentType"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"Identity's display name."}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's first name.","example":"Carol"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's last name.","example":"Adams"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's primary email address.","example":"Carol.Adams@sailpointdemo.com"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was last modified.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's phone number.","example":"+1 440-527-3672"}}></SchemaItem><SchemaItem collapsible={false} name={"synced"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  \nThis date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. \nThere may be some delay between the `synced` time and the time when the updated data is actually available in the search API. "}}></SchemaItem><SchemaItem collapsible={false} name={"inactive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the identity is inactive.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"protected"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the identity is protected.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's status in SailPoint.","example":"UNREGISTERED"}}></SchemaItem><SchemaItem collapsible={false} name={"employeeNumber"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's employee number.","example":"1a2a3d4e"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>manager</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Identity's manager.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of identity's manager.","example":"2c9180867dfe694b017e208e27c05799"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of identity's manager.","example":"Amanda.Ross"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of identity's manager.","example":"Amanda.Ross"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"isManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the identity is a manager of other identities.","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"}>identityProfile</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Identity's identity profile.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity profile's ID.","example":"3bc8ad26b8664945866b31339d1ff7d2"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity profile's name.","example":"HR Employees"}}></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"}>source</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Identity's source.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of identity's source.","example":"2c91808b6e9e6fb8016eec1a2b6f7b5f"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of identity's source.","example":"ODS-HR-Employees"}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map or dictionary of key/value pairs.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"Map or dictionary of key/value pairs.","example":{"country":"US","firstname":"Carol","cloudStatus":"UNREGISTERED"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"processingState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's processing state.","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>processingDetails</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Identity's processing details.

</div><SchemaItem collapsible={false} name={"date"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"stage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"In Process"}}></SchemaItem><SchemaItem collapsible={false} name={"retryCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","example":0,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"stackTrace"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"<stack trace>"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"<message>"}}></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"}>accounts</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of accounts associated with the identity.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Account ID.","example":"John.Doe"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Delimited File","description":"Type of source returned."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the account is disabled.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the account is locked.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the account is privileged.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"manuallyCorrelated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the account has been manually correlated to an identity.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"passwordLastSet"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"A date-time in ISO-8601 format","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>entitlementAttributes</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"}}>

Map or dictionary of key/value pairs.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"Map or dictionary of key/value pairs.","example":{"moderator":true,"admin":true,"trust_level":"4"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of accounts associated with the identity.","format":"int32","example":3}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apps</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of applications the identity 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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The SailPoint generated unique ID","example":"2c9180837dfe6949017e21f3d8cd6d49"}}></SchemaItem><SchemaItem collapsible={false} name={"accountId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID generated by the source","example":"CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}></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={"appCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of applications the identity has access to.","example":2}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>access</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of access items assigned to the identity.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessProfileSummary"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Q. Doe"}}></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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}>owner</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Q. Doe"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true}}></SchemaItem></TabItem><TabItem label={"AccessProfileEntitlement"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Q. Doe"}}></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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>source</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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"}}></SchemaItem><SchemaItem collapsible={false} name={"standalone"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem></TabItem><TabItem label={"AccessProfileRole"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Q. Doe"}}></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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Q. Doe"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"revocable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of access items assigned to the identity.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of entitlements assigned to the identity.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"roleCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of roles assigned to the identity.","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"accessProfileCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of access profiles assigned to the identity.","example":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owns</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Access items the identity owns.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sources</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}}><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","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}>accessProfiles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}>roles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}>apps</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></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"}>governanceGroups</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808568c529c60168cca6f90c1313","description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Doe","description":"The human readable name of the referenced object."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"fallbackApprover"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"ownsCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number of access items the identity owns.","example":5}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags that have been applied to the object.","example":["TAG_1","TAG_2"],"title":"Tags","items":{"type":"string"}}}></SchemaItem></TabItem><TabItem label={"RoleDocument"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The unique ID of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":true,"description":"The human readable name of the referenced object."}}></SchemaItem><SchemaItem collapsible={false} name={"_type"} required={true} schemaName={"DocumentType"} qualifierMessage={"**Possible values:** [`accessprofile`, `accountactivity`, `account`, `aggregation`, `entitlement`, `event`, `identity`, `role`]"} schema={{"description":"Enum representing the currently supported document types.\n\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofile","accountactivity","account","aggregation","entitlement","event","identity","role"],"example":"identity","title":"DocumentType"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access item's description.","example":"The admin role"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was created.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the time when the object was last modified.","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"synced"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API.  \nThis date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. \nThere may be some delay between the `synced` time and the time when the updated data is actually available in the search API. ","nullable":true,"format":"date-time","example":"2018-06-25T20:22:33.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the access item is currently enabled.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the access item can be requested.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether comments are required for requests to access the item.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Owner's identity.

</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's email.","example":"cloud-support@sailpoint.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"}>accessProfiles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Access profiles included with the 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","example":"2c91809c6faade77016fb4f0b63407ae","description":"Access profile's unique ID."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Admin Access","description":"Access profile's display name."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessProfileCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of access profiles included with the role.","format":"int32","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"tags"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Tags that have been applied to the object.","example":["TAG_1","TAG_2"],"title":"Tags","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>segments</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Segments with the 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","example":"b009b6e3-b56d-41d9-8735-cb532ea0b017","description":"Segment's unique ID."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Test Segment","description":"Segment's display name."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segmentCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of segments with the role.","format":"int32","example":1}}></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"}}>

Entitlements included with the 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={"hasPermissions"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement has permissions.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's description.","example":"Cloud engineering"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement attribute's name.","example":"memberOf"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's value.","example":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}}></SchemaItem><SchemaItem collapsible={false} name={"schema"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's schema.","example":"group"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether the entitlement is privileged.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's ID.","example":"2c918084575812550157589064f33b89"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's name.","example":"CN=Cloud Engineering,DC=sailpoint,DC=COM"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of entitlements included with the role.","format":"int32","example":3}}></SchemaItem></TabItem></SchemaTabs></div><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  \"aggregations\": {\n    \"Identity Locations\": {\n      \"buckets\": [\n        {\n          \"key\": \"Austin\",\n          \"doc_count\": 109\n        },\n        {\n          \"key\": \"London\",\n          \"doc_count\": 64\n        },\n        {\n          \"key\": \"San Jose\",\n          \"doc_count\": 27\n        },\n        {\n          \"key\": \"Brussels\",\n          \"doc_count\": 26\n        },\n        {\n          \"key\": \"Sao Paulo\",\n          \"doc_count\": 24\n        },\n        {\n          \"key\": \"Munich\",\n          \"doc_count\": 23\n        },\n        {\n          \"key\": \"Singapore\",\n          \"doc_count\": 22\n        },\n        {\n          \"key\": \"Tokyo\",\n          \"doc_count\": 20\n        },\n        {\n          \"key\": \"Taipei\",\n          \"doc_count\": 16\n        }\n      ]\n    }\n  },\n  \"hits\": [\n    null,\n    null,\n    null,\n    null,\n    null,\n    null\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"text/csv"} value={"text/csv"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  \"Identity Locations,Count\",\n  \"Munich,23\",\n  \"Brussels,26\",\n  \"Singapore,22\",\n  \"Tokyo,20\",\n  \"Taipei,16\",\n  \"London,64\",\n  \"Austin,109\",\n  \"Sao Paulo,24\",\n  \"San Jose,27\"\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>