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

139 lines
67 KiB
Plaintext
Raw Blame History

---
id: list-roles
sidebar_label: List Roles
hide_title: true
hide_table_of_contents: true
api: eJztPWtz4sayf2WK82ETCmFeNuCq1L0EvA4nXuMDePfmOlt7BmkEygqJaCR7yZb/++numdEDsI2dvUk2lw/JYmke/e6enp7R51K4EhGPvTAYOqXTku/JeBz6QpYqpZjPZen0pqT+fl8pOULakbfCxtB0uvAk610NWSTiJAok4wx7s9Bl1KP6c/Bz0GNx+FEE7M6LF9i4wkbj8w+9wZvhZYWNRxdn5ncYqT8n19/TE8aTeBFGXrxmME0kfk28SDgwGrO577NYT14FOFc84ksRiwih/VzyELhfExGt4V0Ab+BPN4wsmcy4s4S3lZK0F2LJS6efS/F6he9lHHnBvHS/iePQZasovPUc4VSY6/k4CcwtNM4AEKHMbTuMHBgB4btb8BhhvvWkN/MFPsIeXuB4No+hSxHPoSOCGNCssim0uuV+IpCE2CVFDIcTQEH4xYO0BxsOiG7YVK6E7XFf9y+Xl6JcrgAonr3AzhJIGS944DBXd0AqIsBmsFcShquyHmvVaux7DlACyQXgJqIojBQPNMqegq5czlO1XC6CSwC5nlAz5qGONX2CEAjHTH9kpPjElysf+XFcP+nU6sdOs+F2ujWb14879YbdrXdqneax0xDQ2IhE6dTlvhT3ld2c972lF5c2+XoZxkIBouihJRnRWvJP3jJZakriaxoCIT6ugUxPhGA3b5vUfhIDSXnksH7o+8LGwdlVKo3vv1nE8UqeHh054lb4qGhVyT1/FXpBXLXD5ZHnBEd85R1JPY5lp+NYmVR/S1AswwiFCH4uSV2r2zTIUfC4tkPKYVoxFxF0VKOoR80GPAAOINalU+inKaAGcYTLEz/GP+4fonHoulJsE3lEjwFmrQFuAoobCQnDMXhRZdcyASlc52SFzESZCF5GxVnxuRdw4lUUJvOF1j0cQn41vPgdrEip/zDx7TAJtmkPhqscR4koMxDdOw8IvwpXia9ICbr7P9Y0jLlv9bF3GUm6CgMp2EJwBxSY+IANg2Q5g7/BIGmqK625CxPfYTNRMAqGb2hmykomyuxOIKnmAVDMIY8w8QJbkEEH64IWiAOjARRGiIBdCtiC3wp4DDwi4mB7b7nidlxhShEjARxbigDMMpkRkBQpcNYyDfIdYV5WhgqgVapMVMDWAHYiDTRfhQQhPjuEaBaCn+VBKScnyhY+JCvagz3HA76mLin3E0leDj2OoZZcBzH/xFS3GYpC8AeT9B8KL4DM0nB+i7x9bZ6SP0pWK/CBIvOALgwV3uFrMD2+I0luVTQURvIURyiXPadcPmVl8SuIXlBWz5CY6VN5p5/akUDvTi/mIKk+/DcX8K/QDZahQ0bu4RbhXQAU2DWlVhcO8YR+WS74y9x7Jn5lJAX7+0iJhHlULHJmCjWPW1Ig+QHfbYmZwGh/cXlBhDelZaKe7ScrwAISgwrTbK+wjL0FzlAry7zcnycUW4k5GLnY8pwvxRuKZwXYypikHa2hWK7idYVxx/GwETlkE+lSHK8C2BCcgwonOVguLiXYdBWPI30mCtJvwLqlriPz6sOBWgzA7BolsnlIajuJIvgb5kwCfgu8RBGu6L5rJTvQLAstjWCB0ICnoOC0GDrWZsd2120cW52mfWK12icNq1trNy3R7Ljt2azBReOk0hAdpwPRpNVozWyr5TTqVrcOzdvcdZ1Zq92c1Z7BK/BofuIIKwk0esTofcw1GvYtJr1bCAr1QfbIuamQR/lnWm5ANI/u1w6BkECH3LR65cXQ/W9IUBnJzWfEexhZsz1H6PIONMCZS2VNniS89lmbJHuPjxTwEmnRqNXwnyLGF/l1IwyKmMH82JCvVj6um6Dh0S8SW3/epiyPIo788GKxlLnn4ewXUP6t4KhHE+HKMUIbEnsKNM/ZpVybi15w245ZoOEwuG4DypJdYMtEUnzhCzeG2AkCjrsFrH7JSFCsE1AfWLYhh+88iXHO7hUXhSuK6EUB1+ugk3ar67Q7nWat3m7xOm/VRL1RP653UOuVYO6DzCKBAAsMIXfIeTieXPl8zXCAPJYlWhZciGAeL0qn9UYnDxE2YI3jkzZOrQ3i07MPTDBK3e9A0EzXnEVz4IEVe0tRJEENFLbWtGr1aaNx2mycHneq9Vrrf0lluTMK/HWqW6npfQFAPgd2mAGqz4CrMW3UTgG0xsNwFebeBg2FBzligr9NCd7kW/Z6g20ZdNdRwBmaUbS6MgGrKsA5gqZJkDsWeNIHw2B7egUM2EOMulTPReJJoAMs4SQE4xC8zjwGcmJjsASuw1t50kb5XnJhiwAoB708BrhAiI+Dw5wwL4wJP6Ab/IAAXI8TJIGtZjETL/kcIY3sBEL3yMPW4H8924sTB8yP8AVaJ1ijC1gpbcwJyumtJLwDU7CCngpix+NL8xw8O5ouYAHFW7vMRUZ8bdW29Yb6KlKD9que1S2Togbe5q4IcIF3UxoOzi6nw+lP29m1EY2P/XYaGJ0NyuwMWAxcbIM/fmUGfcXQxwarJP5d9iaFESi2j4lMEz2es8Nu8daJy2GNKVq1+ok7a4lavWM3aifN7v5264enbZYKpdkQ5A7eFCwy4BrCOjVWkSdnV6PJFB9e9ab9H8h1AiFppUnEBn23VUCjY5Vijo4meiULQPwucuvgswSLuBKQkZ6RMIyFC2tpWAwjobhtCymvohBCtbyoPe0Kn+/zhgODbI9mZXraAtiuCz6p1qm3j+viBDxR10VfVD+pd+tdYdscgX5IGza0C96qhAPRC9ikteu5etDr988mkw9X49Hr4cXZq21XXETnJVzTalycCZU5I8zGuy8p5EX4C/SBHzrpkhqBopgV+2rvnRO5Xl7AQPQI8IJPukf8qTla42fJYBHTs2wUpmJQlRbSCwibGAooK5nf38g+OAuo62A6UsY1x0Uycxdnb+DfIgvzL/Y0gsXZhoNdIVy33W6CIWw2avWWqDdBaRq1Lv3xmJQ8HhgU580LTRGC/uV3OeZVW92acB1xXBldfzeK5v0Qf0xEdOvZYiBWcWXQ/+6Hf/UG+K8f2twvyEpuUpIUjLoE5g3lwlshDpswPy4P71BP9TK1ki4jdeYxjc88WpiCCZhHnJY+8Jd2PdhYrVW1eZCg8tJdZxIFs2FqiKO5yFa1GmiSNTb3bgEMs6OVjfx8Jz+Z9i4HvfEAHhlf+uFiOJk+sKWG3Zi9gBWvjTD+JtSOU6zNIif0gbkZiUFBMMkBUQ3DEHMjYxHfhYQdpt/XWW6DElwGtFM21NtTmsxE4twMABcsWr1AOU2Aa6nJlFJSfEKWSUCElvp5RPcZHZZ84N60vcqlD2wII1KmIjeEszM6URTNZBKneJPOMNEEQt+iFikK6ucL54CoIJmhnOLLBkJbIpJusj4mJ2f/uu5dTODB5Wj6If2jP7qc9oaX+BPmHE8nH94Npz/AX2eXg/Q3wAL/H423RaoXsGzyglEzE+Qp1td0GaVdgFgfxfrxIHmXIaJohVQ0Z8jT0JDHgPwsicHpgqOhxD880k9AJ/MuAXP1KHSbQpPy8MVBdwWd8+j6ckrULBj/jQgoFd87nZtBCeVShrZHW7qpFkRCGy5JWZJUJ8gLb2EvK7R1rNFPn2F6JudZK5T+wSzmrfDXG248RWAXG38UayPxmkTr/bIC+SgjhWwDLrXX7engeBcxKHejLGYGcTpcVSy55yNsMkwiWwx3utXHpSwLTSc0BnOjcGkserBN3E0U0KxF/C6oUpxHFQa4aYQqjVvCirgkkDnx2J2MabTdJqdkzDEsSOudRh0C4C45wywndqPwy7Hj/YOcI8oQGd7iguP5xJlQM71cwUQtxrFIqyfUMNqth1k+11MWGuwCuzuKjuKNdG9qb2gxRevjVCQ8KhMR3GVB6MAcuhigYooK0r7YMgxICJWlqrDMLFaYsYoVljOKCmRjFitq6jQeNlwAJ2ni/EL+U20t7k4q2zzyhajawLK63XW7sxPX+W8UX9ydhsZ2uCS3svB8B9Zoz4mFH+fhwd0c3M3B3RzczcHdHNzNF3E3B/dycC8H93JwL39B93JwJ3+mO7nfzboLrLRqbmf/tywzOh7El5xSSrINUdykEVh6xHo0zm++mJ23/K4dVqabymzSkUjgW4CN8pCZkkYiS3FWctsJKdckDJWrdaoQDPSCak9DTKDCzMa3KvB0A6yZwpS4dQtWm1cfJ1rjQLTnE62uNlhMxvf31PhEZr+U3HbuAIKqYCokjln0gDt+frZfm9kP/dF4fHbRmw5Hl/D78vXwXHno/GZg+mAMluFsMv3Qu4JXb3sXBWcODy+GfRoJI6jem6ve8Dz/8wMMNj0b45Oz8XT4Otf44nqi34wuL8/609H4w6T/w9mb3kaQUCmdj96ejS97l/2zD+fj0fVVbrciv3GRgZ4+0sDDo4vh67P+T3083jLtTbHRVW8yeTcaDz5cjQAHHAlPv+A/1/TPZJR7NRldj/v4dNo7V///AJicnY/GP9Gfkx9hrsn1BU41PrsajafZ3zjQ2+HowmBu2NDrT4dvFQ4Ax48KtV1xJfLPKJn2wshi0pTBdJSvCsUSR+1FjFBdhndYzh1xkIfEjpNIPFBEkcn+IA6nyn1u7av+WWUWj1urPXak08NMBZCmi3DJJTuDHioG577H5eWLgLiWEK/umrIwY1wVerL7h7aE0n5PWmmzSNq0EYDSTKCZFJ/AYEqIZ005bK70NTVlFVV/YKKxgvnZNorbW1cIpy/m3F7ncAjc8PmLmWKZAJaYOuBrbCzCVbVuxF402/B6LgLQCtw5hPAfGqmNVrD1ZZykDEFSwMCwr1nE6UQDVl7biK0Ml0IXEGMJDp3pmAlTgQHDqNLwrV1M1L/UM1GAhQMHIfPDYA6839jGrLJ3CyxgALJLMx9VacgY/38XRh8xlIJgT1fNAuhLb0710YhJuvIFl1V0CdvgFCosxCdPwroIK8Rz5zi4z1ZJtAolOj6Kx7hH88gEgng1sT7ukUpryr/iXibqSepzr3I+KC2+QD7lLUW+wHhXQXF+71z31kXGBXiMzBSOlFTyZwxeMifGCTNVXxnzaJ4v6TClPnIfMFQXXZbTDwPXm+/axd2w74V5aLPZmyfa2qdHAFP9ebxmSp09iuU4XQg9ixqmrikyFkzXcaM2qBlVJKcPnjIzHfsFnqZF8ek42yTbJsUGCcEmedzvvxwNFOsVwge/d8NKtg7m+QLQqpm4P8Gq750h4Y5icn26JDt8IlaqdJ0G2wZqz3I5g/X0iSBw9O6Soq43vcveOf3aCq+2YpCBPhAj0+PCQNKEU0nbPAqTVXpyVhfU0+lifbrWEIkwrTJaY0t9VEPXgqgzGOUywYaniEZZCWsh44Hqqppq8LHxGx7wedY8jT6W/OMGNVXXTXxxjB47R+IFdKLvHFGqqMEo75EdVk6952ytTxobug+dclnZ34K73yJuKjbY5QWJmLTCP032meEqKoNHKx4S8rxIIPQ74ugM0NaJ3e526l2Ln3Rdq9XlDWsm7JmFh5vbdS5OTuyTYhleQfhfhxFVdd8XwgVjl2E9H6/TJmiwb0N1cmIPa6mVDl9sJz/NOPsZ0OpXbEF1vffXYkL3Bff/1IZuSsfBnB7M6ddsTlGet4ypPhK3T0YqO0r9OFnMqbfhgJIMZgbKJvNgXclvSXgyjdzN2ctCsHxTctuz+qzDm9axKxyr5TotizuNrtXR5cVtUe9Cj0bXnp3YtROr7vCO1WoKbnVmomXNmvXGsdtoddwGL73fzPNTwsAcmNlI8iP5sH1r18m+vu9h9v2MquctNt64Q8T4k1no0D0vXgDM8Qi1554BfMDEOAI8AxhqZ48th9ewzLdghUZlrqrg34aO2jTTahWP7ashjUjvyLcDJar1wumBvkYG5SziNur4bkXaSHYEdHrKdMHDTeZE8o5pRVvw2Umt22i5Jy3OG51WvX0867q82ax1j7uU+QHjL8HwPO0BznHdD4pK1d7eb0AQWLZL7exp8v3NPI2xB/1xr061TdHU8LJYfIorjLPv+1es1WY+D+YJPefzDSIE1vVkV05NDTyKvLn36L714Ox1z6QYdV4Tx9qVMtRX+oRkxhfhHUGsEcDjgyqDgDmKsh61DAjxQOYbeuovuQZXs2Tac0MPPfuOHvmh1RZhXpVIbz7F7BuvKqoVWHKnZ5hmXGbl1WVcEq9i60JTsqyv/vg2n+lXu2/SnKHijpPtn7kJZjkpFxomMSYRPHsj6ZmRcqvGWtuPizxTUDkA8qflpGfH6MgJzbwWptKiQcyuXFKU28xKZkQjkuK9BDZgQdkuO4wwJ8ZmgJsXS6bNETlUMDyBaZdarMKBCITmjQJmEIf0zuaJ3EPvrnwwPxahlr64FVr5qALBBIpZcshYJJ19pM7m2ipDC6P4qbs/6O5Bdw+6u4/ubr4c6/sM9FsKferboc91oK+wQ+e5FfpEQiXfzT13v6kllGIklQLoEOmf76b6Dj3M2n5aURHAl4uPlCvfAr6X8mNjFWhcf8YLBJDoqJMBYImEc0pwZxCrIJFI1dye7TUeBAcBDXaEiAlu+KzDhFZfURLQKp9DlOyEQgavYn1blErwkgWk7LZjqVthDpHkIZI8eKODN/rbeKNDJHnQ3YPufp26+2gkmUJF2qLjJJkslzxaK0nT79XBa2iQXQuWqtytKa7NRys4GEtjrFIxcijNGvVZ3W3bouXwlnPS7LoN+6TBj9v1dn3WarRLeV9/k+lxqmRFncrxW/GRSAxBHO50JAEIl4zD0Cmm/xK8MdBFs0bFeiZuBpoDSd+nsWOjux07TsMQs+lrEyHJQgwZZDRCmwZtl9jWFByoG2DUUX8wVV6oMtXeUsAoWCOiLv9F5UUsYNxobfVc3HrSN6VqIUtn0ZeoSbIEWLJCWVzuYWWmizEfjEAR7JyrS4+/UHSqWfS7Ink2Rowv6Lrjs0+2EKjoaeR+vCu/OwTgI7QRE8XgBxK9arXD8a66tIwojTsP8fkhPj/4+IOP/3v4+EN8ftDdg+5+nbr7jPhcR0MPx+fQYO/4HNpWayyNpV5T8c4fHaaTqmgISLxZaNOVh04Wg1MhBDzEunmcBKvx+0qUewneDHtT8pzgFCvlrSSAwM3+KJxTPDKAdmj7zZLKYPLvnn5Do73Hi4WXAqQaaTOnr0+sOEJQOor0LcJqzaGokUQ+vDLXh38GIQHhuK/ylVc1B1mD8I7uEL9t7jB5WJug1BuMppOounC8sVxNUiXWRlQ5r0wtTaAYrWuxSulV5Y+Ob842rMMEjCsNU8FTA1qS6TGAuYJlzCupb3a7pxv/N3AE3K4j//4pfPTN6w/goQZ5AI9d5Ht0LmjPAMoN9BD895lg5WrUtsQr82G4RmxsTTbCZg32veAR1grStsk3/3w3/VafY8jOHZjP6bArEBGyoj2zhfBRHWDLf3KkV9ikQa1lrg8IM/0FifwxoDH4AyIpdhJkgrDX/pfX80K/B74X8XNgsQEd2/AwWsA2GkV1eeLNyuDFc3i9FIh/mNEsNZpFo+HF+QUoFGlvbFX0Y4PpwCG4L4laL55cjWflxrPo0j8LR92EASmh4ShurdmGay+GozCeheMV4fg5eKfOahe6MWWmzPmTIbMXYSjFfzGGooNqcDNPQIteDBbViFmkEVajlgPJUlNangUBKcF3AYoRKGHiMwwIKB4KIVQMHKWS/ybOgs7/m04A/buAMz2+Ab+NLZ3QfsYXGTZgxgktnNBSNkBq+JVbRMEC3UYcVL0wCUA/4z9ZAg1ozuapsXZadRr+iPqga7ABVBpFrk7VH6eZgdO/GL3A1mkbMMEYz6ebjfgpMj0W+sYCsUwmYpOC2/D6IbjkDbopeNNMGLrpvxq+iHEvS9jg1ZNf2ko/YEn+Onb3T7J4B0vzd7Q0OsL2zKlOvRTJC7mK1rbTh9KcgIS3pKkUysNCKfseS36Ylc9jlGnSaXvhCUo8rASP1fdXAIVwSXoI4S4qP52qhIHmdHgzAoC5r4ukq+wdrOwCG0iMqzos1YBRfwn18m4CVL5CJrGBYRzDcxNJgPXuAESyZBzE4wnuOp60E2WEYJEXCIMZ3YDA0l5GI1FskBR0FgVvqx25+jrjHBOfmAt4aD5GAoSkYzPqey8ZImPhk5Rhu2L4/dTYIDnWQvgrOtYLYMEqMTfDm+F0a0QYLFB3y1TDaH6kO8kjbAuD4FJHCUOzCqtJuiUnlDGso3LjUsm5+crKxhco0jT8X+fLntqNYPx/tMJ0GWKVqPWIWu3dlCLzddIFYIsPPn/GFAoufe7xsfpWD64BgfT6xOyurzrkCXD47Ocf+dnPnVyma7o2v9uqsyelEi5392fn3+Rrn4/QyXzl9IUE+v/1pc5H6Jh+yfSFhDx8dvPr++zmI+Jgvq36Qmk4fDvzr/vtzMecTvqV1Bfy/fAFzEfpm31u9OVW9u/5FcunIqHC90BfSLyv6uuSjxBk90c3M6K8z3YyIPp/D/2Uk6WlgBpCba7mem2VHxV2mc7PcFHGH0hx6R841f39fwAtWus8
sidebar_class_name: "get api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Roles' (list-roles)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>List Roles</h1>
<MethodEndpoint method={"get"} path={"/roles"}></MethodEndpoint>
This API returns a list of Roles.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"for-subadmin","schema":{"type":"string"},"description":"If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"5168015d32f890ca15812c9180835d2e","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Note that for this API the maximum value for limit is 50.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":50,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":50,"default":50}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**requestable**: *eq*","example":"requestable eq false","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, created, modified**","example":"name,-modified","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"for-segment-ids","schema":{"type":"string","format":"comma-separated"},"description":"If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs.\n\nIf segmentation is currently unavailable, specifying this parameter results in an error.","example":"0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"include-unsegmented","schema":{"type":"boolean","default":true},"description":"Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.","example":false,"required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of Roles
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result.","example":"2c918086749d78830174a1a40e121518"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `<= 128 characters`"} schema={{"type":"string","description":"The human-readable display name of the Role","maxLength":128,"example":"Role 2567"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Role was created","format":"date-time","example":"2021-03-01T22:32:58.104Z","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Role was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"A human-readable description of the Role","example":"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of this object.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.","example":"support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessProfiles</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Access Profile","example":"ff808081751e6e129f1518161919ecca"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`]"} schema={{"type":"string","description":"Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.","enum":["ACCESS_PROFILE"],"example":"ACCESS_PROFILE"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the Access Profile. This field is ignored on input.","example":"Access Profile 2567"}}></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={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`]"} schema={{"type":"string","description":"Entitlement's DTO type.","enum":["ENTITLEMENT"],"example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Entitlement's ID.","example":"2c91809773dee32014e13e122092014e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Entitlement's display name.","example":"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local"}}></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"}>membership</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"}}>
When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMembershipSelectorType"} qualifierMessage={"**Possible values:** [`STANDARD`, `IDENTITY_LIST`]"} schema={{"type":"string","enum":["STANDARD","IDENTITY_LIST"],"description":"This enum characterizes the type of a Role's membership selector. Only the following two are fully supported:\n\nSTANDARD: Indicates that Role membership is defined in terms of a criteria expression\n\nIDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed","example":"IDENTITY_LIST","title":"RoleMembershipSelectorType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>criteria</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"}}>
Defines STANDARD type Role membership
</div><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"RoleCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS","title":"RoleCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>key</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"}}>
Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"RoleCriteriaKeyType"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCOUNT`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT","title":"RoleCriteriaKeyType"}}></SchemaItem><SchemaItem collapsible={false} name={"property"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"stringValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.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"}>children</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"}}>
Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"RoleCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS","title":"RoleCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>key</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"}}>
Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"RoleCriteriaKeyType"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCOUNT`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT","title":"RoleCriteriaKeyType"}}></SchemaItem><SchemaItem collapsible={false} name={"property"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"stringValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.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"}>children</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"}}>
Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"RoleCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","STARTS_WITH","ENDS_WITH","AND","OR"],"description":"An operation","example":"EQUALS","title":"RoleCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>key</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"}}>
Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"RoleCriteriaKeyType"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCOUNT`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["IDENTITY","ACCOUNT","ENTITLEMENT"],"description":"Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively.","example":"ACCOUNT","title":"RoleCriteriaKeyType"}}></SchemaItem><SchemaItem collapsible={false} name={"property"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute or entitlement to which the associated criteria applies.","example":"attribute.email"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT","example":"2c9180867427f3a301745aec18211519"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"stringValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identities</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"}}>
Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Human-readable display name of the Identity.","example":"Thomas Edison"}}></SchemaItem><SchemaItem collapsible={false} name={"aliasName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"User name of the Identity","example":"t.edison"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>legacyMembershipInfo</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"}}>
This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration.","example":{"type":"IDENTITY_LIST"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Role is enabled or not.","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the Role can be the target of access requests.","example":true,"default":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"}>accessRequestConfig</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"}}>
Access request configuration for this object
</div><SchemaItem collapsible={false} name={"commentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":true,"nullable":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"denialCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":true,"nullable":true,"default":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"}>approvalSchemes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List describing the steps in approving the request
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"approverType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`OWNER`, `MANAGER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"}}></SchemaItem><SchemaItem collapsible={false} name={"approverId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revocationRequestConfig</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"}}>
Revocation request configuration for this object.
</div><SchemaItem collapsible={false} name={"commentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the requester of the containing object must provide comments justifying the request","example":false,"nullable":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"denialCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether an approver must provide comments when denying the request","example":false,"nullable":true,"default":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"}>approvalSchemes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List describing the steps in approving the revocation request
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"approverType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`OWNER`, `MANAGER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n\n**OWNER**: Owner of the associated Role\n\n**MANAGER**: Manager of the Identity making the request\n\n**GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field","example":"GOVERNANCE_GROUP"}}></SchemaItem><SchemaItem collapsible={false} name={"approverId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Id of the specific approver, used only when approverType is GOVERNANCE_GROUP","example":"46c79819-a69f-49a2-becb-12c971ae66c6"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"segments"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Role is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"2c918086749d78830174a1a40e121518\",\n \"name\": \"Role 2567\",\n \"created\": \"2021-03-01T22:32:58.104Z\",\n \"modified\": \"2021-03-02T20:22:28.104Z\",\n \"description\": \"Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"support\"\n },\n \"accessProfiles\": [\n {\n \"id\": \"ff808081751e6e129f1518161919ecca\",\n \"type\": \"ACCESS_PROFILE\",\n \"name\": \"Access Profile 2567\"\n }\n ],\n \"entitlements\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"id\": \"2c91809773dee32014e13e122092014e\",\n \"name\": \"CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local\"\n }\n ],\n \"membership\": {\n \"type\": \"IDENTITY_LIST\",\n \"criteria\": {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"attribute.email\",\n \"sourceId\": \"2c9180867427f3a301745aec18211519\"\n },\n \"stringValue\": \"carlee.cert1c9f9b6fd@mailinator.com\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"attribute.email\",\n \"sourceId\": \"2c9180867427f3a301745aec18211519\"\n },\n \"stringValue\": \"carlee.cert1c9f9b6fd@mailinator.com\",\n \"children\": [\n {\n \"operation\": \"EQUALS\",\n \"key\": {\n \"type\": \"ACCOUNT\",\n \"property\": \"attribute.email\",\n \"sourceId\": \"2c9180867427f3a301745aec18211519\"\n },\n \"stringValue\": \"carlee.cert1c9f9b6fd@mailinator.com\"\n }\n ]\n }\n ]\n },\n \"identities\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Thomas Edison\",\n \"aliasName\": \"t.edison\"\n }\n ]\n },\n \"legacyMembershipInfo\": {\n \"type\": \"IDENTITY_LIST\"\n },\n \"enabled\": true,\n \"requestable\": true,\n \"accessRequestConfig\": {\n \"commentsRequired\": true,\n \"denialCommentsRequired\": true,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"46c79819-a69f-49a2-becb-12c971ae66c6\"\n }\n ]\n },\n \"revocationRequestConfig\": {\n \"commentsRequired\": false,\n \"denialCommentsRequired\": false,\n \"approvalSchemes\": [\n {\n \"approverType\": \"GOVERNANCE_GROUP\",\n \"approverId\": \"46c79819-a69f-49a2-becb-12c971ae66c6\"\n }\n ]\n },\n \"segments\": [\n \"f7b1b8a3-5fed-4fd4-ad29-82014e137e19\",\n \"29cb6c06-1da8-43ea-8be4-b3125f248f2a\"\n ]\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink