mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
96 lines
32 KiB
Plaintext
96 lines
32 KiB
Plaintext
---
|
|
id: get-identity-outlier-snapshots
|
|
sidebar_label: IAI Identity Outliers Summary
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21z2zYS/isY9kMSjyjJ8lusLzeK43TUceqcJV/uansuEAlJaEiABcjEqsf//XYXIEW92HGcTC9JNdNJLRJY7Ps+CwI3gc6E4bnUqh8H3WAi8n4sVC7z2WmRJ1KYgeKZnercBo0g5xMbdC+Cfq/P/GsbXDWCWNjIyAypAI3hVFrWe9NnRkRCfhCWcWaLNOVmxiKtci6VVJMuy6eCqSIdCcP0mEm3rITh+ZTnLCpsrlN4N+W2sTRW+7UbjKuY3uWzTNTeXKoz8UchDa5d5FNt5J8kI7ORdgOfSC67JZ0w5YpPRAocdI3g8ROQNeOGpyJHCbsXN4FEyf4ohJnBOwVv4GciU5kHy+K/5tc1VoGFIslBJg1/5oVRzUs1EIJd/GuHdDTIQQRuYnakk0RExOSbaumrp9M8z2y31YrFB5GgrZqWyyTTUuXNSKctGasWz2TLejphVNEJ5yI8Y2NtWKqNYFLBnylpowm8G6cnsP2YJ1Y0AnHN0ywB8Tp77UZgo6lIedC9CVDDIB2sKybCwExHxj3a6cCDFOyaFmnQhXkpv3Z/E5VYjDlogX7d3jbWa1OPx1asqvOUHgPboEG09LhIEq9VBi+a7NwWPElmzGYikmMpYvZR5lO2RdbZQsVnfCIVz8FLpkYXkynR8Yb5bszxBcao1O+U7/VNNBqLplgKZB9UqC4fnrMq9pj1iQE1PJZJjv6u1omwwrbNDSQAGCoUcngRnJy+/e+g/7p/0jvrD/8DLwbDs/Oj4flZ7yS4utNh3KKYl+5a4XZZoleOzzIoCwujSLzSXszOIEFdMzdtBM4k1V/sHD85uYCz0PP57FJdqlflUwbZ1RZZpk0O7KEjUVgAKf0RX0MIJLGlzOhyuza2ixS2tkqTvYRg2Nrqsq2JaLBEbAU1Pwvqg9hEsMug0+50wjb8dzDstLvbO93OYXNnb39/93m7s//bZRDcZSGLPN5roZrngoZSHlqBmgDJVo03AGrfuOlQ4GXDDdyzh5kNbLJkpTttsxpqt1f4yGZaWWFR1512G/+3pMYiioSIRdxkZ1SRLEukzal6jn4HmWyTHfNo6n8h3/P6DbE+gZLOphLSaILKQv3nMF9GthXpQoFtahUamJxCQaUqehP8OxzqnCfhEY5b5WyIhRwHlPmd6DXXuU+Z+W4hOwQIKoQjyLMskRGl09bvFqnerE7mxnD0UpmL1NaeO4Gx9ht0AcQi87ePzF6r4GgFrJTKXbD0ElGQcsH29wVSDAPCXKZiNaHD4rErhIKNiuR9xUIM/uuiwnDVqlL7R25ZBIgI47HOHWSE7bC9F7a3h9vPu7vt7s5e8+Cg8xvySRas0OG6YrXEFFl8FdxVMVIhwZS/L4MePV/YvM4UQAu/eL+Cko9YvoZDP5uB9pyFidIUmGvXL8txvbyjI8O6pN4Senu/uL0lNwelr8ZMD4I5w4wS+mjGvDeus0hGtBj01iJ4mjFezqlAlZ1ZiAWMtM+NJR8zjsPddfnmCERROTs2BtR5N5cjHc8w10j1gScy/gJeluMXfBty+ZGO14bNMkBQIpwYaFGAQ0EsRzCRAcUPMkbjE2pzJEtsROOaCwECmmhusxc8ZmdeviMvDJrZ8AgdqR9/mqFzJWE+K6eAe1ZuuWZZcSD4aL992Nkd7+9y3nm+u32wNzoc852d9uHe4SGunoIfQLNj1yTExaV/FgoAR8QSHYFF/gSFQCYA3RMDtPjDcyjReID+MUO5sZWYnl+Wi+scGj724ugN2z1gCVeTgp7zyZISVHg+QBACzs5H+Cg3hQDJHeFTIydS3ZfQXx6/6p2fDOHJ2fE/z48H8BfSWsnlPQXeGqNbakodU/2ROPYCUNwJRAlYa7c81S0QiCtbHyhtLQiZTw8ww6++ZkadNBsbnS6EEsXNdc6eyqZoNtgIn0FpgJI+4hYmgAlx+JbLHeGJ1+QWc6X6WZP14liikJAZIRqBKMyfASHG49gBK9eKQSgLarcgaTOlAQSIRVvMVblojXmuO6kbBYMDOP+0n/SiHLo+8omFKKy8xbPo7QM8O80tcjdczpKIIKEMRtRQRtoYBEAjkE0CrPHpiIAcJB5VjqsyVj2FU7p77Zh5mWt6F/HCPiDu3iSQfkISrXrxQfjgo50El43IGqWZfEby+Zwm+1GVucrAd1BzE7ub2N3E7gNjd/nlme+y/FuCPtur0OdclbuP6wCaIe9RemmL0hmywUAhHiL98nYIgf1eKBwvrjNs+b4iPnKlfBVZVvbwHXUJfcvSP7cFMkh6dBKMIROJuEt8zzl2MJZUtbO62ittRhIcVK2BiJA1DZvpgnFQmSkUbh8z3BWOtbDqSc6mHPIjJ4TrMiCuquLQ9e8bJLlBkptqtKlGP0w12iDJTexuYvf7jN17kWTFFUWLx0nl7jB5mn+P0nIGA1i538+qkCNTLaMVJMYqjBUsIodg1NkebY8PIrEb8914f+dw3In2O3zvYPtge7TbOQjqtf5iHsdVkC3GVM3ezo6kYgBxHwDHFQq/BuRax4vbfwV+2xljWsPUU+Fm0Dmo9KrCjp3DNd8NtGavuZqVCMkuYEg11xHmNBib4lhTjoUBnD5qKAapSgJf6EoyFUAFv0Qx+pCMwYtSAF0zC3tj/IzoAqV0smoVqaKkAA4pEyQaUbMGx5IgpBgj5gMKhGAnkJ2/Ijr1JvoiJM/OUOITlJgdX7vvRKxC7nvr9nf7wLzBHDFwBr5jo9d1O1yBA0BD4HJWhTs3+HyDzzc1flPjf4wav8Hnm9jdxO73Gbufgc89Grobn8OAB+NzGNtsswpLvaITAn81TKdQ8RyQezMdRYWh7eYSgxOuAFfyp4Uxh/B8Cj9a/uBG6BSCKaURONDv2ClMAsPKk1Y3YCWwzm2TZ7JZni5U+iMdtxqBatZkHTwe4CIMB9DBLrdAk/RqJLquy3NE3GnZn7YIqhNd91LGo2tovpkuILMRmQae2PFuRI+BxQx6iCeWRjfJbVbkA7nOTXL75bI4QnfIsk59964G4xlwuiQiinCF5gJzAyGy1znwc+SSVK9AE19c1ccMEJQ7DldGzgsNNnKdFYZOcViHvRDcQMfgvm08/eXt8BmbIBSlVOBO+AmJvQME0xtwI0p1vXKfHydR9Zkf6u0tfEnB0GLjBJTC/Cnf8mz7r1ADziBpk9pxkqA8gbMefhaQL8y740zvpQrZS2nc4Sp3pMiLSC0gu8hKuXhNrscy8VNJLXTUQqKG5xAXuHCqvYjcyZwI4htJ8MSSth69uKMX1uhhgwVPkOoyD6gJz8fi96+otNqj+VigFyK9RT4u1duphDq7OI25tMYslMkkZn0WTbW24h+MoetgqFxMCoi0R7P1ERcNKSLCTrvGUuiWDGUIqJH4O4HAUM6Z+AirNoEWPGetYhe278iykBfe0Unfdwsy0+MLKK44MtbRZxxwXeIZFwxxwdDlCev5d7ULHQtPHoIMlAecAxzN7U+ZwDNay42O1trMT+RbNAfLB17XICo267of3XkS9H+5Sx04uhoDqRpBd/VFEH4zTwsL2IKyyu2CZQ2u8ptoqJtLenP8VttVWEu/NXlR4t58V+VUJbOvnaXvyCTfTt79P2W8Tab5ETONh8HobrSs7xfqTv7CY7rVXT5Lp6/hX3hLsUqIG/oZd20JUUydUJbwHL2aojqaSkH7A5ngOeLDBnqWTikSoZXH8IcukAhN6Ni2AZY5dHQyAXq0g12uzClgHPhEu+JvW7gj/7BWNIV+UzTZW2jZVARmwXYNz2DAu9+179sGYJk3aFj2sjQ2gK40LRTeFAK2i5RxcKlPeEQsbVS4xAXdmxKlLjRBv2pWGcXoaihCkxoXk9rTMW49Q1dbM/wn1gK7W7/vDKpHK/orK3NBzkRCnonjFqH9p2iDt4VTkWTYMELWBQAmaiu87g9XKAIxZUEuaMy1mbT8JNvCsUAEWyjnPjvN7WY7pJYCnmfa5tDi1ojjzczSfaormmxQXTBYcMab+b77D3Jp09czbERaGW6uoZYK1zy5NvUiWG1ToamZgibx5c0Nbr5g33aLj919JmyGwLYYcPNbbXdq8vu6/7lWY+8FbmeU11v9hoW75vVwPfy9Lm7eo8fqYusjFfm4a5j3MORvfj6Snc0dyrvuUN6j8vld1Udq/W97+fEepc6vl86VejXfPKMNq/L+ISVxN81tqNdmrXxyRirVJufPx1CDb/8H+b/xBQ==
|
|
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 Identity Outliers Summary' (get-identity-outlier-snapshots)"
|
|
---
|
|
|
|
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 Identity Outliers Summary</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/outlier-summaries"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API receives a summary containing: the number of identities that customer has, the number of outliers, and the type of outlier
|
|
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={{"name":"type","in":"query","description":"Type of the identity outliers snapshot to filter on","required":false,"schema":{"type":"string","enum":["LOW_SIMILARITY","STRUCTURAL"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**snapshotDate**: *ge, le*","example":"snapshotDate ge \"2022-02-07T20:13:29.356648026Z\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **snapshotDate**","example":"snapshotDate","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of 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={"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={"snapshotDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date the bulk outlier detection ran/snapshot was created","example":"2021-05-01T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"totalOutliers"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of outliers for the customer making the request","example":50}}></SchemaItem><SchemaItem collapsible={false} name={"totalIdentities"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of identities for the customer making the request","example":5000}}></SchemaItem><SchemaItem collapsible={false} name={"totalIgnored"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","default":0,"example":0}}></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 \"type\": \"LOW_SIMILARITY\",\n \"snapshotDate\": \"2021-05-01T18:40:35.772Z\",\n \"totalOutliers\": 50,\n \"totalIdentities\": 5000,\n \"totalIgnored\": 0\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Accepted - Returned if the request was successfully accepted into the system.
|
|
|
|
</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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
object
|
|
|
|
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} 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> |