mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
131 lines
48 KiB
Plaintext
131 lines
48 KiB
Plaintext
---
|
|
id: get-saved-search
|
|
sidebar_label: Return saved search by ID
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtX2zgW/1d0vB+m7cFJCIEWvuymITCZoYRJQruzlEMVW0k0daysZQNZDv/73nslv/Ig9LE7j5MvEFvS1X3fn2TLD07Mx9o5unL6/Fb4rC945E2c6x3HF9qL5CyWKnSOnJ6IkyjULJ4IpmfCkyMJvTWN0TSm8jF0dhw1ExHHMR0fRo1FTGQt1R1nxiM+FbGIcMoHRyLpGY+xKYQGuJK+szh355ipEc0ciX8nQscwp6+8ZCrCuAK9tTcRU+4cPTjxfIY0dBzJcOw87jg4QEYCeImjROw44p5PZwH2qXuHu29qb/YP3nj79UPvoLYLvzx+MDqsebt7u3vO4zUO1zMVaqGReL1Ww39l3gYlrkr6AM48FcbAJA7js1kgPVJN9TeNYx+WGVfD34QXw0AeBN0RqWixZRahimNpeAJtrWSpyAjrHBvblLVTVEbNF42D2n7DHYnDmtvYa3B3+KYhXO9guLe3f+jXvIMGqlPdhSJaPSM1pXZa9ounxTCti/YDDsNkir7ZbLW6l+eDm1a312ufNQed7jn8Pj/pnEInaGz3+zcXve5J56yd3+i1f7ls9wc3zQtoet88My1IB39dXJx1WkQJrlrNdxfNzmnx5w0QG7R7eKfdG3ROCp3PLvu2pXt+3m4Nur2bfuvH9rsm3GqfDzqDs/a7Ns1y2n3f7p03z1vtm9Ne9/ICbnWOqcuvhZ8F1rNblnm4ddY5abd+bZ21b/qD5gA7XTT7/Q/d3vHNRRdkQEq9Lo3uXdK/frfQ1O9e9lp4d9A8NX9vQJL2abf3K132f4a5+pdnOFWvfdHtDfJrJPS+0z1LJU/N0GwNOu+NDMDHz0a0pZTRDBnaz+aD1DXQxBovjgddzXQym6kIQ+dOxhMZUpeODzEj4/m5umMyHEUc/CHxIP+ISslrC6qE7nTrOFYD9CHw1XWhIf2UFeOMm2Jjc6Io5ZkrQ4rmv84ZQ678nhiJSISeyGKp469y+2Wm8xQorXLggscYdZiTpV5KPV8iAIRjMoTsVOBlqFQgeLjEzIeJAC6i5TkZXN9KLYcB2FgxHs5VKNgwiY2qUdgKG+AoqBwB2jsIGA/u+FyzoWAjHmjBOBWYSCCxUDFoRFpaxIyXJ4OOhmXGY8NLLKfkHr4Y8SSAlEsUC3qg60cw1qacagrRKtfBlo0pboULHUvNQS8+456nkjDWqPIS+VWzFe48f9IwCQKca7ngrWDiMffPQpk+R/k3q8mLBI/FmiDzoWmJY7CnhoCWsYTyNmeWwPPkGKloysGqDlJ20dhlH6/tvnFrB259f1CvHdXrR/U3ld1a41/F1AADB5JEc6bKJwCzmvkAEs4TEqSDfw/GZehLz+h/tXvq1FXaKIX00uA04+A/u5tIuEFhteRGPIr4HHNXLKYrJmlDOge0MwNYhEkoHNNMXhJBUovBonk2t/MB8abvSxzOA3bLA8BJbApRDRHPfZ86Eo1RgumdioCClBEqYJ3CeR0iACcWWoNHjmQA+thxrFdzL5a3knwUO5MOESfS5a39YXOo6RQpQ+AVpuvcMKU+qSk6oS/u0Q5Zv6tix+tHhHxBMg3XWMg2ovaHiBsRU4MSXqSI2uBrFfmQYXNTTcTcpEsYY3Uv/JcMPIsJDh1SLEy1FVT+MRysMUupp2Y8EkfspqTKmx26UVDlvHCLfo7HkRhTTcfLgo7p8tb+SOsU/Oahz25QzTersSDPXORiBSpcdsqn8xKVl835m7ptStyAzmWA9p4I7q9DvuTWKVnTcRPdDyr6zNqG+AJ6MOwXkEOLfIb6ZQQeUq+b0xrBiuz4Us8CPqcEnvOMmR9vsyyxp/2FSywUuhYZu8YpYWUTzdesMUxqoR4s0ZgOyknn6hdq6pP8jC6uX0zieKaPqtW7u7uKMN0rnqqOE5CoKsKqKJKoRiliqu5X6lWayvV14JpfRrPmojKJp8HfivdfMj0HL75no0hNyTiGn+P+2Sb7/COtkS98WzUpm79EVyDlrYlv02bD24iABXfMZQglBSKasymAE+kaDGQYX5WAF6vIou/nK9xCJkp5pTxESeTtCtP1IRWw4RxTtLi3kCzmnyEdQG7xhI/aZuqWMJ5gnzR0/8RsiM2/awCnQjw+AVtKnu6gb1jvHsnI/r42ORzbCbqR3yLbz7BRosE+WAtRKXHu1JBlwU766eK4wRZZKF4vykdeFJhdkIcl2dev/VcJQ2SsNLTHAAJllcE04x3yN1RPaW3w4PAYuAeUDrXaC1TiNxOowJGMIb/fir5KIq+4MG//s9Mf9ImCFyR+Lo6pIS2MmUL3XvP8FJeeEQ/HRCZQdyaLUs6EHrh6wqKZY8lnDwXkdOju1t3aLtokBH40sJxxBDVvsX+9Bp2x/6PxEBSukqJ9Oy8s7N+hgKC2KW2L/diDfDgL1FwQEmipCGopYsMmlkfBjiFxe7GCJHm9rBYImxhaS5ItzYB90Wk3Q+50m+RrUZlxB1P8/3fQLHOS1IZG4hK6SpvSIndCnKVL98zomwOAumLxtRKYQEj9vrKkwsyNVsB+bGJD8OFsh4CoV1ZkvGLFNg52vTiT9buNiIHm+EEzEfozJc2O5vrKtGtWAZm3L5LvIPAG9wSob8inZHFJTeMKpl0Ur7jof3oVnVvuLerLKQbcsrzUtNXs12m2cKdHcfGY5Y5VGqCmFWHwvCJWVEiK+emvxZ82vW3Ujc00doDO6um3acRkCYtMi46SLotTvFqAz4WNjWMRG2C7shWrApBtrNrlb0FZBUO3owgqq8t66cJNlh5LgIf7c+MN4IfS/6YnAGWX94n1lvJXbpOXmT2RoXDHEWBO4FAQyx4MRAx3K32sD1MV4fYSkkxjhfqV9w1BE5Vd9pb7IK+Rr2WFQZNE3PsMtJ6zgXkZShjP0iG4A4sIZc204rXgw4PaYb0xOmhwXn/T2H29Pzwc8b292uH+4SHt3wDY4OOVILM89akIRSQ9yO0eWOQ/oBBAGqB7A5Fw8ucvLInGM/Rvagn2zcS0/EJw3sewHmZvWxes8ZoFEM8J3efjBSWE7mV/aR0AkhvC3UiOZfjUE5Pj9kkz3dS3TxKQ1qpNemmCV9HTm4m6I46tALjfpUVAGKbCXlmqr0Agbh8G2o7SPhqca1AmsyENI+zsK0YUSedLtDSUKG7uY/ZCVkRlB5IZ3JvyGDDtkCNmVybPvmoC8JzF7pnV5Cu7AH9ZYd+Ibgobp5kqF5F6mkXOikah9Hwfb/YTAJAJMEdiFqMw8xbLorUP8Gw0V+au8ADSqHRudm48s8eqIoSntA8vY81sOkJzaUg8Ydovy1jFdEvp7p1h5jhW1ObxRD8j7i4CSD8uiZY13AobfFSeTDYia6RmshkJGulBEQ62vTJzpYFvFjTb2N3G7jZ2nxm7i409+26DbSXos7sMfS5DbrYEsHguQZ/sUV3ayTzrNYbcYaAQC5F++jCAwP4sQuwv7mfSwtLvhI9MKV9ivpnZw9wfpqvjtPTntkAGSY9GghFkIuEfEd85x6Qoo6q95dlOVDSU4KDhCogIWTNic5XgnjuLkjBETrjeYb4SOvwhZhNAosxso5gMKGnh4mYrly2S3CLJbTXaVqO/RjXaIslt7G5j988Zu08iyYwrihaLk3QynXJ8jkwvBZp2lJYz6MDSt2xZFnKFHd4crSAxlmEsp4wcnGF9d7g7eu2Jhs8b/sHe4ajuHdT5/uvd17vDRv21U6z1V3kcZ0FWjqmCvY0d7SPvCB+MJiE4l46V8svbf6DeSIwwrdErcCluBp1XaNMyxY6NZex4rmKQDTfI3fy9kIXtxcveGaMH4oY86o2eYSHMNqozLwUipEQfBk1LHW+h4xY6bsvPtvz8ZcrPFjpuY3cbu3/O2P0i6NjYBB0bXwAdGwwh1oieqf+O0NEH3IHQbARGARnsWzr56zt299GGfcyjsYgzoFdCkfXDFS8AKMXe8XCegiVd2okMc3VheoO+U+wbpX3p/cQxpMiQQdaSyrysIacCMSm+8hTIqaQ4RoGAbjR3myN8zm9iJnv5IZ3FvhWhKSkECvde8VCHBHcSI4R/QIH2QfEFye+4x2mt9U37wayHEp+hxKx97wmBMZ/t/+6vekugA8xHmC76xtZrXhcwe+Y8hGWEuJ+Z9JVB0C1U30L1bbnflvu/RrnfQvVt7G5j988Zu18A1S0aWg/VocOzoTr0rdRYhqVO6N3Q/zdip1CxHJB7M+URVvdzDE64AlzJfugCcwh+yeLIqdKRUdee/9HVB+k/QqtZARiGkiiAjulZqAewE9jnscJnspKedwnVXcVT0+rt3oqsgy+ZmgiDvOUnHq0amhcdu8yokHYjiQ5ssh1NYHRt37Z1NOic3i54kn56Zm4OKxBmyOzgCQLrTHQb2JzBSuIHbU+YmLMMCzKCbJdR8LhJnvd7T8lhiKyRY5X6npwL+jPgckE8ZP8azQUGT0/YXQI/LZOm8IQM3Lsu9ukjLDccLvXMSw0+EKgvMdTFbnX2FrwFz2bQOzIvfvoweMnGCEYpGZjTdULi6gHC6QLciJJdM31fBAdR/YlUMqYjo6xZeiMHg4uNAlAK+xj2hWBXxa8s9CBtk9pxkKBMgaPy03q+uBUBFshKrm10TumHVdBilZfGmbOptGqQoTkADXcrH0PXHpeRWNSxjxWRFoHsapbKxQtyfS0Tf0upuYaaS9T0ywUujGqvPPOGtxcJUgsPNGnrqyc39NwCPVxiwR2kusgDasLyUX6Pykut9tV8lOi5SK/Mx8fwAx0yLg9jJrExDYUy8FmHeROltPg7Y+g6GCpXdGDzq9mik80uRYRbrxVYcs2UrnQBNxJ/ZxAYoXEmPsS6TbBFmR0UCttPZFnIC5/oqPGnksx0+wrKK/b0lae/mmec0MUJXZMntOXfVC90LIhtlMF8HoEcoJXbnzKBZbSQFw2tlZmfyFdpDJYPD1glKnp2ZC6O8iRofzFqwN5ZH0jTzpGTv1kG18zSwhJWUla6YbCowWV+AwWVc0Fvht/ssSdW0z+avChxM99X6YbB/Htn6TWZ5I+Td3+njLfNNH/FTGOBMLobTZt+KKPg5AbRLe/yafq+CvyFVopUQtywnqEVGmGYIplZwGP0aYppbyIF7Q/MBI8RHe6gX6kpxSFAYgx+WAUSoTEdLo6AYQ4rOhkAvQr7gOf3PFAxLr7wvVyg+puyq7A+aPmCjvYdp4YDADWdJiF+eAmYSKb43aFN1vWl9hKThGAtFopUMkUwLhuVRiS6DaqCDsnhKb7uCDeSJZ7Adp45F9hQ211kUCRaxH5WLxekJwLyMuxXhuibaIPnuBMRzHD5BxkUwJQozPCuM1iiCMRC++hCReOqHaSr2BeI4HLIOMNeBRZ99CEqpWNYqxbomt3z8md4hnPWOV70qId88/zZnyu0SR/RenWGe1B0ktWsMMxq7sopr+Zg0JH5tNcEWMX2hwfcpsC1zSPetl/MuLrOly60hMi+zpCec1zL/IuePdr4km369OFK/tOdtnCeL7Id+PlZ4NocmH+8LnzSBFgzDWZ7pTBk6QEELnmyJe9pG2z4+F/hZn44
|
|
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 'Return saved search by ID' (get-saved-search)"
|
|
---
|
|
|
|
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"}>Return saved search by ID</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/saved-searches/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Returns the specified saved search.
|
|
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","description":"ID of the requested document.","schema":{"type":"string"},"required":true,"example":"2c91808568c529c60168cca6f90c1313"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The requested saved search.
|
|
|
|
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The saved search ID.\n","type":"string","example":"0de46054-fe90-434a-b84e-c6b3359d0c64"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The owner of the saved search.
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The id of the object.\n","type":"string","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the identity that owns this saved search.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"public"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the saved search.\n","type":"string","example":"Disabled accounts"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The description of the saved search.\n","type":"string","nullable":true,"example":"Disabled accounts"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The date the saved search was initially created.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The last date the saved search was modified.\n","type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z","title":"DateTime"}}></SchemaItem><SchemaItem collapsible={false} name={"indices"} required={true} schemaName={"Index[]"} qualifierMessage={"**Possible values:** [`accessprofiles`, `accountactivities`, `entitlements`, `events`, `identities`, `roles`, `*`]"} schema={{"description":"The names of the Elasticsearch indices in which to search.\n","type":"array","example":["identities"],"items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities","title":"Index"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>columns</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The columns to be returned (specifies the order in which they will be presented) for each document type.
|
|
|
|
The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_.
|
|
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> 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={"field"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the field.\n","type":"string","example":"email"}}></SchemaItem><SchemaItem collapsible={false} name={"header"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the header.\n","type":"string","example":"Work Email"}}></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={"query"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL.\n","type":"string","example":"@accounts(disabled:true)"}}></SchemaItem><SchemaItem collapsible={false} name={"fields"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields to be searched against in a multi-field query.\n","type":"array","nullable":true,"example":["disabled"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>orderBy</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"}}>
|
|
|
|
Sort by index. This takes precedence over the `sort` property.
|
|
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> string[]</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><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div><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={"sort"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields to be used to sort the search results.\n","type":"array","example":["displayName"],"nullable":true,"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>filters</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The filters to be applied for each filtered field name.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"FilterType"} qualifierMessage={"**Possible values:** [`EXISTS`, `RANGE`, `TERMS`]"} schema={{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE","title":"FilterType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>range</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The range of values to be filtered.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lower</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The lower bound of the range.
|
|
|
|
</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>upper</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The upper bound of the range.
|
|
|
|
</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"terms"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}}}></SchemaItem><SchemaItem collapsible={false} name={"exclude"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"0de46054-fe90-434a-b84e-c6b3359d0c64\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\"\n },\n \"ownerId\": \"2c91808568c529c60168cca6f90c1313\",\n \"public\": false,\n \"name\": \"Disabled accounts\",\n \"description\": \"Disabled accounts\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"indices\": [\n \"identities\"\n ],\n \"columns\": {\n \"identity\": [\n {\n \"field\": \"displayName\",\n \"header\": \"Display Name\"\n },\n {\n \"field\": \"e-mail\",\n \"header\": \"Work Email\"\n }\n ]\n },\n \"query\": \"@accounts(disabled:true)\",\n \"fields\": [\n \"disabled\"\n ],\n \"orderBy\": {\n \"identity\": [\n \"lastName\",\n \"firstName\"\n ],\n \"role\": [\n \"name\"\n ]\n },\n \"sort\": [\n \"displayName\"\n ],\n \"filters\": {\n \"attributes.cloudAuthoritativeSource\": {\n \"type\": \"EXISTS\",\n \"exclude\": true\n },\n \"accessCount\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"3\"\n }\n }\n },\n \"created\": {\n \"type\": \"RANGE\",\n \"range\": {\n \"lower\": {\n \"value\": \"2019-12-01\",\n \"inclusive\": true\n },\n \"upper\": {\n \"value\": \"2020-01-01\"\n }\n }\n },\n \"source.name\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"HR Employees\",\n \"Corporate Active Directory\"\n ],\n \"exclude\": true\n },\n \"protected\": {\n \"type\": \"TERMS\",\n \"terms\": [\n \"true\"\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={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |