mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
88 lines
35 KiB
Plaintext
88 lines
35 KiB
Plaintext
---
|
|
id: get-identity-outliers
|
|
sidebar_label: IAI Get Identity Outliers
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXG1T20gS/itT2g/ZuCxjbAjBVVdXDpAtb0HIgbncHaFux9LYnkSeUTQS4KX479fdM3rzCyEktZfs+kuCpZmefu+nRyPdeToWCU+lVoPQ63kTkQ5CoVKZzk+zNJIiMV7TS/nEeL1Lb9AfsOLyVdMLhQkSGeNsmDucSsP6bwcsEYGQ18IwziJpUqbHTLtZTRZolXKppJqwkKecmSyYMm56TLp1B2EzH87SeSyaLBSpCHARnCGARj6U8TRN5CizF8fldWBETpROYDJXIQtEksqxDEhOJtVYJzP6+706E58ymSCvWTrVifzdjjEB6AUZfya57OXc+zOu+ETMYJVeInj4DHQT84TPgMEENXTnSdTEp0wkc7in4A78jORMpt6iuk74LVPZbARiwjrAQhalhqUa/kyzRLXeq3Mh2OU/u6TT8xQE4UnIDnQUOW28LZa++nmaprHpbW2F4lpEaNOW4TKKtVRpK9CzLRmqLR7LLePo+EFBxy9FeM5ANWwGiqtqqQW8J1ZP4CNjHhnR9MQtn8URiNfZbTc9E0zFjHu9Ow9NBtLBumIiEphpydhL3Q5cmIH1Z9nM68G8Gb+1fxOVUIw5aIF+3d83V2tTj8dGLKvzlC4D26DBdCrYOIsip1UGN1rswmQ8iubMxCIAZxAhu5HplDXIOg1UfMwnUoGHwfxEZ5Mp0XGG+WHM8RXGKNS/XvmBztSy7gdj1kiTTDSYTEGroPhYx1lkVSlY41/+UKc88g9wdgNVGmtlBJtCDIH7kx1w4IpwmHKgqLMoZCPhIgMsB7Ge2w3ju2F9osFuBKqKIj8Ei4HNpApwHohhUsw5HAwNrDAShAVcsSm/FnAZbETKwfFyFvMgbaI0kEkgnekZxHwICyudoqcYgas2iMjfSPIG8kTcXvMoE1YLOBrYzkzOzQ/hQSjPCicaaR0JrryKn9BM8hXnHjS0WfechSIxt3kVzV2k6zy/MqN4bKZWx2MZpegMahWzS9wZKARqAkOFQm++9I5P3/33fHAyOO6fDYb/hhvnw7OLg+HFWf8YS1ch7eLAta5v+TFfws39ovSvrUy5d2cGXRJVkVuRmTmUx1tmp43Q1dUf7DI/WUGBM9/x+Rx993V+FUPCZHGskxTYQ/eidAuk9A3ehtQahYbi0mILnZgeUmg0ynLdaPRYQ3xqMnODkABCTTXsmLFMTHqYV/xDyCE0dgKlPBJuDNZzUEaa5XTcdRf59YtQypMaDa9q/ZKlVihNHPH5G9ADsMXee7/qqXrvFQjCrsjEJ7hFhn/veeucxaB2vsxZKskZ8w33jUCjgJKX/egcyH/nXoQaWPShc3vtcR4EBlvhDM0a5nO2fYRFmytI+TTdu79CK9mSZNAunXYb/1tQeRYEQkANaLEzKkOmBLejD0DVtNgRByxrf+U411TzLuMjSHVFugO2bQWkVWtFcnn9IajIli4Haqj4YCZfW+7vIZd5yIewBHkcRw4Eb30wSPVueTJPEo6OLFMxM5XrViwEvAk6RSqtrmS4ypOXWc9z/TPwVyUhWtyVMcL83AVy2I8VNwlrVt0diW437Ao/2N0J/R0R7vl8vNf1O92X7d2drnjZednFOCm7iMfxNThcqkZUxcFFbdsBHsoxm+XMPYkry8eTi9UKT3BlNNeYySBjUAJaX9ggwSzFwINpCLstP5UzsVJzRIw6sprtbnipuRo7nXZn22/v+u3t4fbL3k67191t7e11/oOMIVT8dpzNtEmpCVVP4q+7zJ8rLGvQUK3CR3zCbqYClgTskljAWFl+CsuPhFA5Sq2yYOFUs5LBVsXfQttTyzaYPWcQ5pjxl3vk6lqQXsrkCHSw1rFzQNRTGPVBj4YyJa2c63F6wwE+HilojgT5f4iFKZ1RVvHy64R37jEbYU4t+baYvmq8caT5siDDipKIBlkpgf4EhBnNSYnlRoCgVVnC8X+oGImesXartV0Vsd3a7wBDkG5I1cPPxOBJ/80FhFvT618MT0/6w8GB11TQRC7F3xFMcCgfIlCOa/aFBsK2mWB7nqUaE39AFzLl550Je4fdAXQGby6Oj5FCPhuyDjrMCt8o2UOe+CgH6hUBvyJqAHPfGBsr4LuKRRwiCEeW/pqvEq5MhDZ4XiwH9wp+/whuvw2vmLldHLhtL6ypeHlnFUQ4gBGQco6SBIzvO5hgu1W7k0BdKBvp0O5QKXAiGWIJ/9IivaYYQ3wAVDvQ4UrNLrYiSviThFN8CWI5gIkMKF7LkBKJC0IgmddIGteqaRM00dpmr3jIzpx8B04Y1F7Cg49A6zHV+MLCgnwKJLACF6xYVuwJPnrR3u/sjF/scN55ubO9tzvaH/Nut72/u7+Pq8+EMXxSy6I5uqkv/YtQkMACFmkIVfk7KCQRHHRPDNDijwdEROMR+sd8Z8cWYjp+WSpuU8C57NXBW7azB+6tJhld55MFJSj/4nxViFnCp4mcSPVQzjs8et2/OB7ClbOjf1wcnQ/XpLw+7pqG6JaatmcgAIljJwDWVCMiqqkt1nBUGyAQV6Y6UNpfZm5AmcztI8AMt/qKGVXSNs1XQ4ni5jZlP8uWaDUh9OEaZA9A4SNuMPyV3YDqA3aPU//YabLhdp6et1g/DCUKCbiaUrqB+XNMzTwMbd9kNxMhlAVtVCGAhxwtA1G3RanKujXKFHJcNQoGB3D+eT/pBykUFPKJWhQW3uJYdPYBnq3m6twNK0ojlWKDGOSlCcptgigCUAKT0FG6dER9GiQelY8rMlY1M1K6O7HMHKaa7gU8M4+Iu7cRpB+fRCtuXAsXfLQXbrMRWSM3k8tIbpuXJrtRhbnywLed5CZ2N7G7id1Hxu7izTO3MeLuEvTZXoY+Fyp/fgZCLEGfRFhku/CQzRqyiVDZQaRf3w0hsD8igDNM3Ma4cfYN8ZEt5UvM9wt7uA2zfD8tL/2lLZBB0qOVYAyZSIQ94rvk2IJEUlV3ebXXOhlJcFC1AiJC1kzYXGcMO64kU9TQcdNkoRZGPUvdwwqICGNsBsRVVejb7bkNktwgyU012lSjP0012iDJTexuYvfHjN0HkWTBFUWLw0n5QwzyNHcfpeUMBpSnRoqQI1MtohUkxgqM5dWRgzfqbI+2x3uB2An5Tviiuz/uBC86fHdve297tNPZ86q1/rKM4yLI6jFVsbe1I6kYQNw14LhM4aO9VOuwvv2X4cOJMaY1TD0Fbgadg0qvCuzY2V/xEFBrdsLVPEdIpoYhVakjzGkwdoZjk3wsDOBsAnlR4WkXCXyhK+G+qc/wQTOjIzUYvCgF0E3mfn+MBxbcQR3nZMUqUgVRBhxSJog0omYNjiXx1MsYMR9QIAQ7gez8DdGpM9FXIXl2hhIfo8Ts6NY+2mUFct9dtb87AOYTzBHn1sBrNnptt8NxyxwaApuzCty5wecbfL6p8Zsa/+eo8Rt8vondTez+mLH7BfjcoaH1+BwGPBqfw9hWmxVY6jUdJf6jYTqFiuOA3JvpIMgS2m7OMTjhCnAl914M5hCeTuHHVuUAn8X6lossieBufn7yDowDRrlv8Vi28tM4St/QIcoRaGRFssFTATawcAAd17QLtEidiUSPtemNiFvlutPYXnFO80HKeEIVrTbXGSQ0ItPE82TOe+gysBhD6/DM0OgWecuSfCDXRRLdf70sltAaWVap78HVYDwDThdERBGu0FxgZSBE9roAfg5sbupnaNnLq+qYc8TilsOlkWV9wf6ts8TQKQ7rsFeCJ/gaEz3S+PnXd8PnbIIIlDKAPbcrJB0V4+wtuBFluH6+vY+TqOiUb6P0aw9QMKLYOAKlMPdyQf7y1htI/WeQq0ntOElQesBZjz/hy2vz1rxK8F757FAm9lyWoTFORPu6xWWcy8Urcj2ViZ9yar6l5hM1PF1c48Kq9jKwB3ICCGskwSND2nry4paeX6GHfRVcQaqLPKAmHB/1x15BbrUn81Gj5yO9Oh/v1bupxNfqatOYzWbMTOl9mgELplob8XfG0HUwVC4nGUTak9m6wUV9igi/066w5NslfekDWCT+jiEwlHUmeyaasAq+9KFCG7a/kWUhL/xGB/B/q8lMly+lIq5DHXzBsfUFnnFBHxf0bZ4wjn9bstCx8EwayEB5wDrAQWl/ygSO0UputLRWZn4iv0VzPDotGdsUY+Ke/dErk6D7y76NiKOLMZCqEWsXDwLhN3O0sG7VlJXvEixqcJnfSEO5XNCb5bfYpcIS+r3JixL3y82UUxXNv3WWXpNJvp+8+3/KeJtM82fMNA79orvRsq5NqDr5K4fpljf3DJ23h3/hLsUqAW1oY8r3PKuE4oin6NUU1cFUCtoWiAVPER8280PUEInQwWP4Q/NHhCYJjKHD4hwaORkBPdq4zlfmFDAWfKJd8bfJ7HF5WCuYQpspWuwddGoqALNgl4ZHL+DeB+3atXOwzFs0LDvMjQ2gazbLFJ6sB7azGePgUp/xiFCaILOJC5o2JXJdaIJ+xaw8itHVUIQW9SvJzJyOcccZmtmK4T+zFtjduO1mUD1a0b2ZVgpyJiLyTBxXh/afow3e5k9FFNOrG8AWdH2VFU4GwyWKQEwZkAv6cZ1Mttwks4VjgQi2UNZ9uq3tVtunlgKux9qk0NlWiOMnCH4RaeFCrPKZgpoj3pVb7X/RLxO42odNy1aM+2+o0cw2WraTvfR05WsOU1A2Xru7w20ZbO3u8bJ9sxH7JTA/xmT5KuNahf9Y3zZYqaiPAjc68k83uK0M+8Ln4/Xw1/oowQN6LD7a8ERFbr4w8ON9YeABd8g/I/FEb3jaRwQe4Md9t+CJ7Gze6v8+3up/wMDlxxueaOPNG/eLb9w/oO3y6weltq/KTV/aaM3ffSdkYafZ5z+VWUsnJJBKsSf/yxFgx/v/AbXqPyo=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IAI Get Identity Outliers' (get-identity-outliers)"
|
|
---
|
|
|
|
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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>IAI Get Identity Outliers</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/outliers"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API receives a list of outliers, containing data such as: identityId, outlier type, detection dates, identity attributes, if identity is ignore, and certification information
|
|
Requires authorization scope of 'iai:outliers-management:read'
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"example":"LOW_SIMILARITY"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**attributes**: *eq, sw, co, in*\n\n**firstDetectionDate**: *ge, le*\n\n**certStatus**: *eq*\n\n**ignored**: *eq*\n\n**score**: *ge, le*","example":"attributes.displayName sw \"John\" and certStatus eq \"false\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **firstDetectionDate, attributes, score**","example":"attributes.displayName,firstDetectionDate,-score"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Succeeded. Returns list of objects. Each object contains information about outliers
|
|
|
|
</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}><li className={"schemaItem"}><summary style={{}}><strong>X-Total-Count</strong><span style={{"opacity":"0.6"}}> integer</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The total result count.
|
|
|
|
</div></div></li></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity's unique identifier for the outlier record","example":"5be33d3e-c54d-4ed7-af73-2380543e8283"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the identity that is detected as an outlier","example":"5be33d3e-c54d-4ed7-af73-2380543e8283"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`LOW_SIMILARITY`, `STRUCTURAL`]"} schema={{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"],"description":"The type of outlier summary","example":"LOW_SIMILARITY"}}></SchemaItem><SchemaItem collapsible={false} name={"firstDetectionDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The first date the outlier was detected","example":"2021-05-01T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"latestDetectionDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The most recent date the outlier was detected","example":"2021-05-03T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"ignored"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag whether or not the outlier has been ignored","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Object containing mapped identity attributes","example":{"displayName":"John Smith","jobTitle":"Software Engineer","department":"Engineering"}}}></SchemaItem><SchemaItem collapsible={false} name={"score"} required={false} schemaName={"float"} qualifierMessage={undefined} schema={{"type":"number","format":"float","description":"The outlier score determined by the detection engine ranging from 0..1","example":0.92}}></SchemaItem><SchemaItem collapsible={false} name={"unignoreType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANUAL`, `AUTOMATIC`, `null`]"} schema={{"type":"string","enum":["MANUAL","AUTOMATIC",null],"description":"Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored","example":"MANUAL","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"unignoreDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"shows date when last time has been unignored outlier","example":"2021-06-01T18:40:35.772Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"ignoreDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"shows date when last time has been ignored outlier","example":"2021-06-01T18:40:35.772Z","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"5be33d3e-c54d-4ed7-af73-2380543e8283\",\n \"identityId\": \"5be33d3e-c54d-4ed7-af73-2380543e8283\",\n \"type\": \"LOW_SIMILARITY\",\n \"firstDetectionDate\": \"2021-05-01T18:40:35.772Z\",\n \"latestDetectionDate\": \"2021-05-03T18:40:35.772Z\",\n \"ignored\": false,\n \"attributes\": {\n \"displayName\": \"John Smith\",\n \"jobTitle\": \"Software Engineer\",\n \"department\": \"Engineering\"\n },\n \"score\": 0.92,\n \"unignoreType\": \"MANUAL\",\n \"unignoreDate\": \"2021-06-01T18:40:35.772Z\",\n \"ignoreDate\": \"2021-06-01T18:40:35.772Z\"\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"}><Markdown> An example of a 403 response object</Markdown><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"}><Markdown> An example of a 500 response object</Markdown><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> |