---
id: list-access-profiles
sidebar_label: List Access Profiles
hide_title: true
hide_table_of_contents: true
api: eJztPWtz2ki2f6WL/ZAZCmEQGIyrpu5lbCfjLcd4DZ7sXsc100gtrBkhET3seFP+73vO6YckxMN2UtlJLh8Sg9R9+vR5n9MPPtWihYh56kfhqVs7rAV+kg4dRyTJRRx5fiCSWqOW8llSO7yuyRfMvLlp1FyROLG/wP7Qe3LrJ2x4ccpikWZxmDDOECCLPLbUt/k+fB8OWRr9KUJ276e32K3BRpdvfhsevz09b7DL0dlJ6fP46mf1dTy6ujwyL6NYP9AtGM/S2yj20wcG+MTiQ+bHwoXBmMODgKUKyyZMbcFjPhepiHGCn2o+zuJDJuIHeBfCG/jqRbGVZFPuzuFto5Y4t2LOa4efaunDAt8naeyHs9rjMjFOPbaIozvfFW6DwaRxEBhbKOIAQkQb7jhR7AIExO/+lqeI852f+NNA4CPs4Yeu7/AUupQosWrqp64IU5h5k02g4x0PMoHkRyhmrjiCAJrDJx6aHuz0mIiJTZOFcHweqP71+lzU6w3AzndusXMC1E1veegyT3VAwuIcNLBXCYBTTO62WuxnDrgDIwTMWMRxFEvOKEL4EsF6vUjrer2MMeHk+UIOWkQ8VVQLIyAn0/2RveIjny8C5NKB0x60RK9/0Oe8K9wBH7Sm7sDd73S7+3bHm0JjLSi1Q48HiXhsrJaHwJ/7aW2Z2+dRKiQikiRKEXBac/7Rn2dzRUx8TSAQ4/0W0GgsBLv+tUPtxylQlccuO4qCQDgInF0YGb354TZNF8nh3p4r7kSAqttMuB8sIj9Mm0403/PdcI8v/L1EwbEcA8fKZf1HwmIexSha8HFOBqBZpUGBgvutFbIPw4qZiKGjhCIfdWx4ABzAWdcOoZ+igATiCo9nQYpfHtfROPK8RFSJPKLHgLPSCy8DdY5FAuAYvGiyqyQDQXwoyArZljoRvI7qtOAzP+TEqzjKZrdKIxFE8s3w4jNYYai/nvhOlIVV2oM5q6dxJuoMRPfeB8IvokUWSFKC7v7TmkQpD6wj7F1Hki6iMBHsVnAXFJj4gA3DbD6F72CTFNWl1txHWeCyqSgZBc03tDR1KRN1di+QVLMQKOaShRn7oSPIzIN1QSPEgdGACqOJgGkK2S2/E/AYeETEwfb+fMGdtMGkIsYCODYXIRhrMiMgKYnAUesE5CeaeV0aKsBWqjJRAVsD2lmisfkmJAjns0KIplEUCB7WCnIibeE6WVF+7Tl+8TV1MdzPEvJ96HQ0tZKHMOUfmew2RVEIvzJJ/ybnBZhZCs8fkbev9VPyR9liAW5Q5E7QA1DRPb4G0xO4CcmtjK+iODlECPW679brh6wuPoDohXX5DIlpnib36qkTC/T59GIGkhrAv5mAv0I1mEcuGbn1LaL7ECiwakilLhyiDPVSvUiiLHbEUp+SK0VsmfjA3tfGQNoLJC0bS2K8rz3djyZIvI2iUzBlqJ3cSgSyCGhSlaoxQPuLyxROeFmixvLZ0+QJ+EGi0mBKNBosF4EKixqWfvl0nlD8JWZgCFPLd78UbygSFmBPU9IItJhivkgfGoy7ro+NyGnrGHkpVZBBcASuRMafHOwcTxLwADKmR0qNJc4/gC00jiaPAU6PZb4BeKjJkYVEojtZHMN3GD0L+R1wFRWiofo+SCmCZnkgqkUMxAf8CoWy5UCzNd13Bp69bx10nJ7V7fdsa9DqdyzROfD606nNhd1r2OLAPWgftCy7O3Wsrmu3rUEbmve557nTbr8zbT2Da+D/gswVVhaq6RHLn2Lc0Q1U2PXuVlBuAFJIrlAGSNKbU8oC4T86aycCQgIdCsNW0jyGYcOSVNWR8HxK8gBjKFEokLy+YkIQBCSMqLCVBcrXLRPvBh/JaSRIFbvVwj/luZ+tTlcBPM4WMMEufLEIMB+DLnt/JNjvU5XaPI458shPxTwpPI+mf4BpqIRX5QExM43R0qS+RNZ3V6ngcvYtQNR1tlcBmIuo7QxA9g54H1Iit9UTrTZ8GoB8Oq7d6g9skjzujsLgwYiIFLVtKJyja9iOwAn8jR6EsFwOHognwsLxrHtI2UXFfFTHDCHsRz3VYcyStcljIJCyKEu3YVOw+oA65ZSBQKkj04OY7RFmBEco1JlGHfFV5ng7fY51uFxGh92DcGsgBcsKYwgr9edL7GuBuWh1rFZ7YtuHHftw/6DZbnX/bxXbjAv4LNQCDlqhQTWfgaE9sVuHgKS9HkMRIivd7XZqnZlagTPWNyRYMkAbW+DbkD1EGZtnCeaWZHoYBPmABBqDULCTXCZKlkZNgaKsqi0Z4eO12rBsDnKhVvarbABk8yoTRYiJ3XXt9PjkfHI6+Ve1KCfRwH5YE4KJUzAhZwuJiyoEBcJLGeKAJhmTbBD9VxroK4beMlxkEF9G2PzeTzCfWl3ZobRIGumyazQ4As2eYtBMgcd3V9gv3u15HHJL0W21e960C2bswLFbvc6g9mR79UsGySAZHyQ9c/1kEfAHFhbMmAyh2SkoALwBgpUoFUF+mspokrOL0XiCDy+Gk6NfSPKAkJRhErFBYxwZmqioo1yeo4FeJSUkPovcKqCsQfJWI/nVwnApPMihIQlGQsl4f5WD+lwPNCbIMiCT/1H8tlobIaKLHF8ZwGVWD/r9DjC602uDq+pAhNSa9lq9tvC6OINtqiFLpKuq1YLUooxvQxKUB/f8IUF+q+5FrNSjJ4sZjrRKtvJJq8FLo4yOx9bw2NKDFbhYqtDLnsDTGlnT3HutCEY2e86hqdaXnGABSxNclxlIsq7tqa/jNIqckbWYxchYfSpkuFcQa9COUAiXfK2OKDcZ3yfGU4VeyqbLypDKChyycTBTThNpVsR9nVCtHQU093gykna2IHxk8c5O3sJflMBCDFR48UR7WB7t9Li5QVXsVrsr2h3Rtu3WgL5sEtfNclEetyjIZQyOzn8qCE6zO2gJzxX7jdHVT6N4dhThh7GI73xHHItF2jg++umXfwyP8W8QOTwoyXhhUJLtRxnRq5rFlw4XCqDZnc+VWOjHTXak80RIufmfJErhMpgwQleSwwGwUYjFaJPYU2bvgC+I5pjoao3Ja6Pi3hj3I0x7wPGMtKZAtgyuBrRHrRXJeHEFHgSOK+eCiyqojVi8DKVKSv9fzKLIs1QTKRXeSFoovI6i0PNnSP4ttqREQNRs6JbJlcZ8icQo72bfI2uzKeEgU7qV3F/HboVEHowpO4OElCNKB62W65gejv0BT00ZwMBZJtEq9SkVT/FB6PPg6OXTAC5D1gn4wefVuN5jGAvjfAFs5Ug8GGNOK57vRyiJVpW2vBAnFlLYCHgVybV2vSwKmgqTLU5/eHHx2+jd+cklPNN/1Vqp/vp2eD58Q5/ejH49uTwfnsPLN5ejq4tqrHCs6oaJWY8F6mecYsBZHGULswipagy0fKsWKjU9iQhN9isqZqLqWKrIhwWqet0gjbXXiY4JTQqRlx1kqdY0LWUaBXe9ZBgAm0sQM9m5SIwKDBW6LXv+iq2RoBQhEcpbHvJZDsdE8MpoFlguuy5THmEM2RvkcEjLNG+QuA0JjCLLfBHa1PemD2r5WAvHqQvmjsxcyT9V2GxkHbu8oNLg6nmaqEKDa9CCkLT/pJlFuUXsK7gUEe32nP7goD2weG/gWd0Bt62pcKZWG3x8v81Fr+f01geEw5L6QrtCw0vtn/wA2FIjp3oXSaF6poW/NB2fZuWbW838V7U7y8jvTNDOBO1M0FcxQah6uQFSJf6nqPuygq5bYtZV/NPjBP/oERq4fs9DiOFpq5UsRvjLC06qGkHrS6Vw+Lrm9aft6QHvWPuecK2u53Yt7toD60BlW33RHkAPe+BMe06rZ7VdfmB1O4JbB1PRtaadtr3v2d0Dz+a1m0eyK7jTK8JI9AhLzLHPq3XEd8S8wn6nW9DZOURsPqCFyOMOBcw1qlUXuWBWyRBK9ZaGJIL4iGt0iVoXE5g9kNbxGUTKSaqW4MxomIDcRvgIc3TcWKPnsrZIsIKhhraf8n2IWPlAi+jc+oELSRdtzCu+HZ4fL7+GzAhMY5aiULgYRRfbH43OJ8PT8zE8ppwIHoFmcDD5uKBW7DqXpmN7/7ETpWnzKODxn7XHGwTzOQie/ONqeFYE/8af4rLSMnqpCMTiFuh9TntotqO537YRvZvHbZ63AGe9PzNono8mv5kvhWF/GeL/cvbAwooHG5tE2IxHYnuxSg1KtRI9mLYhq3qMzBzQpuZke+aaFe0ZMt1V0SrF9FEuJtTrBvl6Xeb41F3i2GA5cRpM04b2VQJ1GsUEvLA1tZTlFxZC5d6k1evMYs79oKJSj4b5z/UkY2qmqga4rC6SdA1N7vfivXRpjd0Qxay4mCdbiASkyen0WfQxaz0GU7UpVM7NQoK4DbN/bUqFAHCIab6RgHzkIvZpMUyX8gzNHR4HQjQd6NJ2Bt5g2vPc/0U+4JZCQACScVoONJr/0tXgY+H5IQRotGSAM3WUkOt4TjNFiqexvSZKysOBLQvLO83faf5O83eav9P871Lzd5r+9TR9DdGHaACQMNTF6HOT6WUAffylREzQKKTa6LJRXivV2zbMLoQmG5oTJiTRscC3dyKg3NeYD6z1mJWoRmFNNBDcAwoC0iVCIOyKpD1uVsczHLZDC42bF4e+XZI8iQT2jgRts2IrV7qu1S4ptQZt9p3crKkgYc0IIXRX7dI8Cnxc1z+h/S8WkKx8jkyXo6eRSycA/RAsnk/FnOfu4lyTL7siBYtwBOTZrv+vwZ9bs5j7iKHcsuNAR7WCh7SmoxsSpHZKK4w/UKLZLu3/OVKTQX7E3MHy5uoaYhmhq9D/gPZfdWF+vuN8lc/pCz7ttQZ21+t1ObcPuu3+/nTg8U6nNdgf0GarOfCNz1ZW7MtDvxEgAxCa0HK//2+By9A8UWsFNPjTy/AE44mbb2RbM02FL/i/j2kDQqafjy5Yt88CHs4yes5nS0QIravxKscrAY9if+ZvjKOOT14Pr84m8OQSfOLJGD4hrEq4NAz1Yc+IKti30T1hrCaAmzETgbtV0WHWFdQ6TIiHSbGhL78lDxDDzJla4YUeavQVPYqgmRdH85Iqkd58TNkPflM0G2BqzH423APr6uJjHXV4kVpnipJ1dfzrR7BHZqu/jD8SvZ+Ou67cQCdP9IEqy+ol7twFx+47Sw46J+WyhdWG5KzIFFQOwPwJftpJcTWFplnUQiMtCsX8MK6kXBm7SYFoRFI8d+LALOiIgxPFMW43gMAFzHbClDmitQQwPKFuZyxWaUcMYvNWInOcRvTO4VnyBL27CMD8WDQ18+JOKOVLTPnWFYUTGdoiqaiJOusDzZoWWvHNSsdOd3e6u9Pdp+ju8stLdTZFvaXQp10Nfa5CdbkBOs9K6BOrdEjfgPBvGTlKRlIapkKkv7+bqMsX5NIPZWBfLj6SrryC/NDwY2mVXrv+nBeIINFR7SUASyTcQ8I7x1gGiUSqTnW011E89UFAwxUhIljNmDb9YwAcZyHtBeNJg7mRSMJXqToxLCsoZAHpxIBryVN/u0hyF0nuvNHOG3033mgXSe50d6e736bubowkDVakLSpOSrL5nMcPUtLUezoMw6BBftjbqJxZXihGKwiMmRirVo4calO7PW17fUd0Xd51e52BZzs9m+/32/32tGv3a0Vff53rsVGysk4V+C35SCSGIA43xGchCFeSRpFbLv9leCOEh2YNTY+Jm4HmTdwWo2NHe1CNHSdRhBsJH3SElJRiyDCnEdo0aDvHtrFuS2cqZmAXQ7xyxo/kJj1/LgAK3pEgL4BC5cVZANz4wRp6eEBB3ZajhMyMok6lJmQJgkhdFsZ9LPp6GPMBBIpgcbPWF4xOFYs+K5JnlzjjM7ry6uSjIwQquonc91fVd0/x6AvaiLFk8JpCr8x2ON5AAAmBtFkm7tzF57v4fOfjdz7++/Dxu/h8p7s73f02dfcZ8bmKhtbH59DgyfE5tG22mImlXtMhz68dppOqKAxIvFnk0PUXbh6D0yEQeIgHQnCQK4jrj6QoDyFoR8303fBQVmOthdwgcIi3dqAdqr6R2/hrN3jl01yAjOJMZ3Sf6IIjvNpeuQdddEahppxlFgfQSF/79gmYD0x/bPKF3/TVIYwwuqe736ZA8RXGTN58gIKIDeiWOTlAk9gV+6gR0nwScMk8dQ63Zq6X2whZ3yTxEGVgMAlMAzc0Kemkx4DiAlKTV4k6rv9INzkuzQ/mdRUHj58/FwlozVxWkW/jaNCeAaZLU8Qp3OQCUzgrWBGb3Ddh7mdXBhthM5v9LHiMJ8VpOeSHv7+b/MhmGL2S9ZBXCerbktkFiAhZx6FeGsBO5LDy62SHpcUX1EbmBTBhpm4H1Qd5zsFtXIKdJ5JiJ0GmBXs9/dJBXuq35i7Q96HFjv1Y3nKVUBs1RXkrxvVCz4sX5vVSJP6moVlKzQgaXnhYwkKS9tqRm3kcMAkIggcJUevFg0t4VgEe5mTwBKEu44CUUHiUl8wczbUX41GCZyG8Mh7vw3fyeFapG5MGS9+xd6pOWf0PYyg6qAbXswy06MVo0ZkwizTCslsFlCw5pOVbEGgSfmegGKEUJnmRGsU5EYSAoStV8nfiLOj873Sz4++lOdPja/DH2NKNnGfcpLmEMw5o4YCWtAGJwl+6OxQs0G2cg7wtggTgKOc/WQKFaMHuSVgrrTqB36M+6BocQJWgJItD+eUwN3DqE6MX2Nq0ATOMcbpZRMTL5xUs9HklYukKwzIFq/gGEbjaJbpJfE2FC93vX22+OOPC8WG8A+5LW+k1luSvY3f/SxZvZ2m+R0ujImcUNxpWpRhFIf9ZxWvVwiBdzyXwQO/FKekqBemQAuWnd4uAFgFPUapJq51bX1BJYSF4Ku/LhUlEc9JEiKhR/SFxJEAzuqQoBpR5oM58U9Fbj8xJYWRgiXyV+5HlnTx0xBhSVNFk7yDLCx1gC2Z4uG0D3v0RqVQvv4X6WDOb4VU7WYiHpQHtbI43im2TCNdPnCzR95CFQtOCNloz00trMYoaToGutRDxPBl56m6rAuO3jAV811fLAunpyg15o28+kUsRyEMz0K4ctm+DDdJm3YpggTkmWF0IwERhhLenkwpEABaq67+jeLanOiV72BYPmcDkpfh0mu1my6J0AU+xR0kKKVcBOJ2/r16hu3Stq6nQf4O/G6NcFuYaewssuSEhMpn7yBzzuracY0LWcgukwlefPmFBBpOuR3ws73PGzBOYp65DVbeArqXZ7udl/vs/L7NSCv4UWLhZ+tUgfSKfzvQ/ncnfya/KbKCT/jWdFxLo/9cvwmygo/nFnBcScvfzLt/ez7tsEAf9Gz4vlIbdb7R8k7/RsskfmR/qeaFI7H5gZSN981+zebkB/t5/JGVbuFT64ZkXkvEb/fGSDaRZ/esuOXlu8kUYSCHwrifpkymfkCDkem+hV2VHVGmp7M0J5oZ8TXVOfcChHh//AycfdzM=
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Access Profiles' (list-access-profiles)"
---

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 Access Profiles</h1>

<MethodEndpoint method={"get"} path={"/access-profiles"}></MethodEndpoint>



This API returns a list of Access Profiles.

A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_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 or SOURCE_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.\n\nA 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin.","example":"8c190e6787aa4ed9a90bd9d5344523fb","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*\n\n**source.id**: *eq, in*","example":"name eq \"SailPoint Support\"","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 Access Profiles 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 Access Profiles. 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 Access Profiles

</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 Access Profile","example":"2c91808a7190d06e01719938fcd20792","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Access Profile","example":"Employee-database-read-write"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Information about the Access Profile","example":"Collection of entitlements to read/write the employee database"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Date the Access Profile was created","format":"date-time","example":"2021-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 Access Profile was last modified.","format":"date-time","example":"2021-03-02T20:22:28.104Z","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement.","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"}>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"}}>

Owner of the Access Profile

</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"}>source</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"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the Source with with which the Access Profile is associated","example":"2c91809773dee3610173fdb0b6061ef4"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"The type of the Source, will always be SOURCE","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the associated Source","example":"ODS-AD-SOURCE"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`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={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported  for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value  **false** in this field results in a 400 error.","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"}>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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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:** [`APP_OWNER`, `OWNER`, `SOURCE_OWNER`, `MANAGER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\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={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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</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:** [`APP_OWNER`, `OWNER`, `SOURCE_OWNER`, `MANAGER`, `GOVERNANCE_GROUP`]"} schema={{"type":"string","enum":["APP_OWNER","OWNER","SOURCE_OWNER","MANAGER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step. Values are as follows.\n**APP_OWNER**: The owner of the Application\n\n**OWNER**: Owner of the associated Access Profile or Role\n\n**SOURCE_OWNER**: Owner of the Source associated with an Access Profile\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","nullable":true,"items":{"type":"string"},"description":"List of IDs of segments, if any, to which this Access Profile is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>provisioningCriteria</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 an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression is evaluated against those Accounts to choose one to provision with the Access Profile.

</div><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"ProvisioningCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `HAS`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS","title":"ProvisioningCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","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.

</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={"ProvisioningCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `HAS`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS","title":"ProvisioningCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","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.

</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={"ProvisioningCriteriaOperation"} qualifierMessage={"**Possible values:** [`EQUALS`, `NOT_EQUALS`, `CONTAINS`, `HAS`, `AND`, `OR`]"} schema={{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","HAS","AND","OR"],"description":"Supported operations on ProvisioningCriteria","example":"EQUALS","title":"ProvisioningCriteriaOperation"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error.","example":"email","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type.","example":"carlee.cert1c9f9b6fd@mailinator.com"}}></SchemaItem><SchemaItem collapsible={false} name={"children"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"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.","example":null,"nullable":true}}></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><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\": \"2c91808a7190d06e01719938fcd20792\",\n    \"name\": \"Employee-database-read-write\",\n    \"description\": \"Collection of entitlements to read/write the employee database\",\n    \"created\": \"2021-03-01T22:32:58.104Z\",\n    \"modified\": \"2021-03-02T20:22:28.104Z\",\n    \"enabled\": true,\n    \"owner\": {\n      \"type\": \"IDENTITY\",\n      \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n      \"name\": \"support\"\n    },\n    \"source\": {\n      \"id\": \"2c91809773dee3610173fdb0b6061ef4\",\n      \"type\": \"SOURCE\",\n      \"name\": \"ODS-AD-SOURCE\"\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    \"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      \"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    \"provisioningCriteria\": {\n      \"operation\": \"OR\",\n      \"children\": [\n        {\n          \"operation\": \"AND\",\n          \"children\": [\n            {\n              \"attribute\": \"dn\",\n              \"operation\": \"CONTAINS\",\n              \"value\": \"useast\"\n            },\n            {\n              \"attribute\": \"manager\",\n              \"operation\": \"CONTAINS\",\n              \"value\": \"Scott.Clark\"\n            }\n          ]\n        },\n        {\n          \"operation\": \"AND\",\n          \"children\": [\n            {\n              \"attribute\": \"dn\",\n              \"operation\": \"EQUALS\",\n              \"value\": \"Gibson\"\n            },\n            {\n              \"attribute\": \"telephoneNumber\",\n              \"operation\": \"CONTAINS\",\n              \"value\": \"512\"\n            }\n          ]\n        }\n      ]\n    }\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

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

Generic localized reason for error

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

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

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

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

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

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

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

Generic localized reason for error

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

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

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

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

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

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

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

Generic localized reason for error

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

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

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