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

155 lines
52 KiB
Plaintext
Raw Blame History

---
id: create-saved-search
sidebar_label: Create a saved search
hide_title: true
hide_table_of_contents: true
api: eJztHGtz2zbyr2DYD00ypiTLj8T+cqfIcqrWsVRJTq7neByIhCQ0FKEjSNs6j//77S5AitTDcp1cX8PJjCMCi8XuYl9YArx3tPCSSMZz5/jy3rnQImqqMBZ3cSOJJ9Dm6Nmx5jfCd7XgkTc59iLBY+FcPVztODEfa4TpIwDrE4AD7b7QXiRnsVShc+w0aYRmnIXilhEyZpBVPoXOjqNmIuII2/YB2uAnjBbhjhOJ/yRCx2+VD2TeL6EfTEQBKYsVA4xa6rgCYz1kJ4xxHJ/NAunRVNVfNQ6+d7Q3EVNOvUHQGZEU4vlMAGI1/FV4MaCYRUhiLIVGuJBPxXoqsIepEYuXKDJsWqw6jmQ4hmdxx6ezAJtOpObDAMC556kkjLXzsCTDdbPlWp4+aZgEAc7lHMdRIrYQAVTEMqbe3HqcI/8PO9vEZNbR30A7dK1QzG65ZjKUsYSlmDOL4Gl8jFQ05bDIDmJ2Ywkk5pmr13bfuLVDt34wqNeO6/Xj+pvKbm3/386CwxMYOJDEmjNVvhzJTcQHXMePcJAO/iMIl6EvPSP/9eqpU1VpIRfSs3TbcfA/u51IY0Nr1IhHEZ/Do4zFdM0krTCZskjMIqHB4oBfmgncSwSPsKI6mc1UBGuazgfIG74vcTgP2A0PwMrZlM/ZUDDu+wRIOEZJnESC3cp4opKYhQpIF5V1RgUkoEcCJRZag0aOZADy2HGsVnMvljeSdBSBSYZTgdoOjzf2h/SpxwBFyiB4hY5tsTAFmHQp2qEv7nAdMrjLPODVA7qjIJmGG1bIdqL0QQKRAKZDEMILPRMe6pQmYajIF1FuqSZiDpIJAhxjZS/8lww0iwkOAL7yEuSRobBA5J/CwYZlKUCCw47EMbsuiPJ6hxpyopznmujneByJMTlZfMzJmB5v7A8rFhzNQ59do5ivC8qW+RWeqUi34GE2KeXjfgnEGGww7Lz/JrBtjhsihwxwvSeCw5qsx0pqnaI1gNvwflTRF9YyyB9M+JMRuqNLS/7VQueapDMElyG4T7XORHXLsuNLPQv4nBz4gmb0/NjMMseewguXSMiB5gm7wikhLkebYrJxLQTBEo3uoOh0Ln+mrj7xz+jh6sUkjmf6uFq9vb2tCANe8VR1nABHVRFWRR5FNRIjAVrsiepBpV6lqVxfB675ZSRrHiqTeBp8l29/yfQctPiOjSI1pcUx9Jz0z7atzz/TGPnCt1GTvPlLVAUS3gb7Nn3WvA0LGHDHXIYQUsCiOZsmQSxdAjSiW+uAl6PIsu5bmoueKKWV/BA5kbdrlq4ProAN5+iixV2FDSYSCOZfwB2Ab/GEj9Jm6gY8EIrsswbwz8ya2PybGnDKxMMjaUtB0x3UDavdIxnZ31fGh2M/pW6kt0j2E9Yo0bA+GAtRKPFCqcHLwjrpx4PjlrXITPFqmT/SoiCGHJbyzSXeN+ep65ghNJYbyn+BoSwymG5sIX1D8VScgnR5DNQPE0jfK16gEh93BQq2C+Dfb0RfJZEncqy2/tXuD/qEwQsSf8GOiSFNtJkceK9x/q6FIZaHY0ITqFvjRclnAsQerD4GzUUu+eShkDkdubt1t7aLaxICPRpIziiCmLcMX68BMMI/GA1B5ipptm/nHbR675FBENuUtj4/9MAfzgI1F5QJNFUEsRRzwwaGR8FOwHF7sQInebUqFjCbGHoLnK3MgLCotNtTbtP7/KzMqIMJ/v+/1CxTknQNDceF7CrtSoPcKVE2QIwPuUXfbgAEisHXcmAMIdX7yooIMzVak/ZjFxuCDvtpNCfslTUeLx+xjYJdLc9k9W5rxkBzfK+ZCP2ZkmG8VrSZ4HbNLiDT9mX0bUy8aTcuDfoULZOY/ZN6Zku7zN5QgR/lIQl6xMEBOscjHui8P6bn/MbxLcrLyRvcKr/UVUr2eZLNtfTILh4y37FOAtS1xgyeFsTyAklzfvpr80/r3rbKxnoaO0Bn8fTrJGK8hM1M84qSbovTfDWXPucKGyciThPbwnjrrIHGmQq10TGILuvlaytPWBLIF2N+SyFqJX16YmFKbtjWFCoU7ZNtyW3NF/uHtYN9dySOau7+3j53h2/2hesdDvf2Do78mne4j0qmbsNNBk1dW4tSW6LYpvjRaDY7F+eD62an12udNQbtzjn8Pj9tvwMg6Gz1+9fdXue0fdZaNPRaP1+0+oPrRhe6PjTOTA/iwV/d7lm7SZgwhDfedxvtd/mf14AMohS2tHqD9mkO+Oyib3s65+et5qDTu+43f2i9b0BT63zQHpy13rdolnedD63eeeO82bp+1+tcdKGpfUIgv+R+5kjPmizx0HTWPm01f2meta77g8YAgbqNfv9jp3dy3e0AD4ip16HRvQv6r9/JdfU7F70mhdzGO/P3Gjhpvev0fqHH/k8wV//iDKfqtbqd3mDxjIg+tDtnKefpMjSag/YHwwPQ8ZNhbaUG3AgZrp8t9KaqYcoM8HAy6OhcIoLJhPWUbZven6tbcJ6jCDL8KPEw5ShkqnlRZoWxWKUZwybTkFnAMcq4zTbq3tHum9qbg8M33kH9yDus7cIvjx+Ojmre7t7u3sp2nVDR/Dmfg1T5vXTrmtlS21+n9qtEt09SotO9DzzwGK0OC0QQbpZdz29hAMwxGYJ3ytGS98V5Yj5OBFARrc6JIe9Gagm7Fgw1PJyrUDDYRhhRI7N2Z2k2HlS94sEtn2uKS+jYGadqF6SWABYqBp2mKhnDLrkwGQAakhmPDS1YRq08IXRsT6nLYn9Z7C+L/WWxvyz2l8X+sthfFvvLYn9Z7C+L/WWxvyz2l8X+siRdFvvLYv9fvdi/thejAqDdr9VW+WtCWIWFbkURRFaX9dKNm+XWnlUFDffnRhtAD6X/VW8AiirvE+lN5a8tkxeJPZWhcMcR5JxAoSCSPRiIOdyN9DE+TFWE5SVEmdoKwRXrhiCJyi57y33g1/DXtMzgkkTc+wK4nlLAvAgljGfpEKzAYoayYVrxWvDhYe2ovj863Oe8/mZ/9/XB8GjE9/ZqRwdHR1S/gWSDj9cmmcWp34lQRNID3+7BivwXBAKZBsjepEg4+dM3loTjCfI3sQRhMzYtvQwPWcN+mL1tdtn+axaAPSfUzsdLQgjdi/7KPgA4N4g7kRzL8LE3Jiet00Za1LdvEhDXuiK9NMar6O3NRN0SxZYBrHdpEVAOU2GvLNZXwBAPdR5Qmic91yBMZk0aRtjZ14zIo15s0VJT8syJdPZCVkRlB5wZtE15DDntkGPOroyffdWAxHMWu2dWkq/sBvxlhX1ldpMrnGaiXM7UUy9yll8Ucs938XY9gQQyAeKIzbwVZtpiSbTrAzQbyRWpG+SERiKdm8qNZ2qsKsL0lOrwMtbMuiNcLg2OJ0zhMo+Vd7fk7t4bYk5iRX0eT/QT7K4bgPtxibWs40ZY46PwZLwRrUa6TNYjQSe9KMLBFipbrtTwzYamtN3SdkvbfaLtLnf27NkG20upz5oDDhchNyUBDJ4rqU/2qi4FMu96zULuMBCITZF+/DgAw/4iQoQXdzNp09JvlB+ZUL5CfCNbD9M+THfHaehfrAUSSHI0HIzAEwn/mOheUEyCMqLaW53tVEVDCQoarkkRwWtGbK4SrLmzKAlDpITrHeYrocPvYzaBTJSZMorxgJI2Lm62cykzyTKTLKNRGY3+HtGozCRL2y1t969pu49mkhlVZC02T9LJdMrxPTIdCjT9yC1nAMDSU7YsM7lchXeRrSAyluVYTjFzcIb13eHu6LUn9n2+7x/uHY3q3mGdH7zefb073K+/dvKx/nJhx5mRFW0qt95mHe0r7whfjCYhKJeOlfKL5T8QbyRG6NboCFyaN4PMK+aIsckd60drSrdKsfc8nKcZki7kkOFCRujTAHaKsFEKS2+Wx+AXQzyMLJUps8upACz0siqQU0nGi1wA3mjuNkZYoTWGkpWt01lsPVuTJwgUZs14HE8Ck2KEOR9goAwWX21/w+zULtFXZfKshxyfIcesdecJgYaeZe4H6+q7bSA+Qh/RNwu8odBrdjs8BAWADYHxWVneWebnZX5exvgyxv89YnyZn5e2W9ruX9N2f0N+brOhzfk5ADw5PwfYSo1ludQpvdX/vdN0MhVLAak3Ux6dhfIXOTjlFaBKSNBMaXIiHD995VTz372iAwUm5TfEJFEAMOkJ1ntYI1ibhwqfyUp6SjFUtxVPTas3e2s8Dh4NMNYFPstPPKo0N7ptu6+okGQjicprPB1NYORsz0g4GuRNNeFH8acnnecqAd9GaHbw3JdVJGoGMmewi/he23OB5gTaEo/A20UUPGzj58PeY3wYJBv4WCe+R+cCeAZULrGH5F/tZJ8262O6bWZf+cDZIoTgFq2+MlkHwersLSgBnpajtxYvfvw4eMnGmGSSkZvzzkLirgDMpAsqQk6skVbwcRDFlUglYzrEzxqFdyRoNGwUAMPsU9gXgl3m7731wB2TSHGQIA+Aoxbnp31xIwIMfJWFJFHxpB9WQUJVXhhnbgvQbkCG5koKtFY+ha49wCgxWCOMZZE2d+xylvLFc3w9l4jvUmyuweYSNv1yiQoj2kvPnLnxIkFi4YEmaT17coPPzeHDrRO0INZlGlASlo7imy0vXbVn01HA5yK+Ih2fwo907aM4jBmHxTQEwMBnbeZNlNLiH4yh6qAZXNIR+meTRXdNXLIIt17LkeSaKV3pQj5I9J2BYYRGmfgQ4zGlIwoytdA3JvmZVhZs/jNd/vhc4JmaLyFsIqSvPP1smnFCFyd0jQ/Qln4TlVCxwLaRB3NhjRSguVh/8gSW0JzPM7jWenVCX6UxGBo8IJWw4AcT6eF44eDsL0YdCJ3BgAt2jp3Fuz54ZhYXhqaCsNJCwLIEV+kNFETEJbkZerNCFEbJPxu/yHFjUS/phMH8W3vpDZ7kz+N3/yCPV3qav6OnsQku1h17i2+othZXPsyNhzX3gZctbB1EdlPjsZuri+u1j0Fld1mLdygLVyh/l2tu2S23zfe+Fte+8tesCresnnFPKb2mtHJdKHc7qLyg8ye6oOOgEyfQ9EJwLnSYPdBqTVzTPXL4C70U/2h/Crt/qmesfPEC9CDGSEGR0ptIQdW0GcgftW4HvbWaUnQD4nFRhTaIxrRGEbgBHvChDABfhX3Eewqg0xGWKvD8EWD9VdmaRR8MoEtXGE5Sdwjbkuk0CfEDE0BEMsXvK2zzmaC8XmJCu6fCUKScKdocZaPSOIfOGEVRSWXcGeFrF4mK7DxxLvCM2r5zAUHmvVrGSE8E5LsRrrip3YYb/LE7EcEMiyWQl8AWJe8337cHKxgBWWjVVUXjqh2kqwgLSLCAYJRhr1Kr1OiDG0rHUx7m8JpPZi996GJZm+4Xr5m2fmPbqjPue6szrNLSLR2zDzfljktnqdwBFjLBegj03N9jCQ/3/g/YbD3k5dVia49PuavR4KC/CHSi9t2ROzDfQUnNe+WlGLpoM8KUBx+FvcqVbLod+jDO0H4afGqqTxG/JXd0C78/wT8HvzJuFACAqB2clK1AAozBmybc6/JN+wPZfHj4HzyHRU0=
sidebar_class_name: "post api-method"
info_path: docs/api/v3/identitynow-v-3-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a saved search' (create-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"}>Create a saved search</h1>
<MethodEndpoint method={"post"} path={"/saved-searches"}></MethodEndpoint>
Creates a new saved search.
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
The saved search to persist.
</div></div><ul style={{"marginLeft":"1rem"}}><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></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
The persisted 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={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink