mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
111 lines
46 KiB
Plaintext
111 lines
46 KiB
Plaintext
---
|
|
id: get-managed-clusters
|
|
sidebar_label: Retrieve all Managed Clusters.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztPGtz27ayfwXD86GNjijrZTv2zJ07siynSv2U5aStkzmFSEhCQpEMQdrR8fi/390F+NLLjtvbe9KrzNQVCWCxb+wuATxYMZ8o6/DWOuM+nwiXdb1ExSJS1seq5QrlRDKMZeBbh9ZAxJEUd4Jxz2OL3dk4iFg8FcxJokj4MbuIJlU24gr6BD6LxJdEqJg5gR+Lr3HNqlpBKCKOoPsuAJ+I2IDMEKhaIY/4TNDD4e2DJRELgBPNoc2HFngMxmMlYmsR1wt6zaQfB4TVOAGcI6ESL2bQUGM3KgEy5kyFwpFjCVjey3jKKp6cybjCYFjIJ9LnsYDxUZBMpgRHg1C1D/61EOz2XYt1LvvsOua+yyPgRuB5wkEc2GWG+8cfp3EcqsOdHRe45yHdNcWlFwaAXs0JZjvS9Xd4KHeUgWM7GRw758Er4vEsiATQBT9nxD1kJXJXRgL4OOaeElVLfOWz0AP+1KuWcqZixq3DByueh8gymFVMRATjNBD9qtWEFzPpy1kyo3GuGHOgFX4/PlZXM5+YtcT7M/6V+clsJCIWjFOOIUcjESeR/93wrrn7B7g341/1b4KS8RKe1nLTCRJ/mZv9MavEUSIqTMago6DGYRAmnlZMwSq/2MMg5p7dxdEVZHcY+EqwqeAuSIC0GjuukMiUA8Qg8Vw2EkY4YAdynFkBcJRVtIVV2L1A5k184KELMgQpSt8RqWVLf8I4CBlQYUQIc7jPphzdBQOpEbOwv5yF3ImrSI1UMBpkOBO+CxP7QYxaogTOWiEg/0WUVxAnwvaOe4nQXMDegHaiUmy+C51CelYo1SgIPMF9q6ApNHKtroylZ3zkEiwFXtqfWI+LinRCQzLpJwpFhpqRUsnU3I/BdvWwEaqC/xez9B+aLsDMNni+QtmepG9RZVQShkEUA3rpkjMGUME9NoMj91xFequXlyBShwihUsmWG+5VKoesIr5UrIJgrEI7E19Y9mg9fkSBaqtSyOdmvY7/W1wcsQfMTQbHmSdhtQNjKy9qqBy0BIKhAwgehp50aJqdTwrhPCzLk0cRR8nLWMzU8sQLCzF0NOOC0Sfgb0kbby3pIgaeBASG2A0enMk74DwCA0LDCAmPpaYUeq+bz0zH+sf5jEbzilzlph+s8Y+p8j4BkTptgrlAMTvHAQA9DJ5GF/tsgj0TEw59bHArXMUNBBtEkyfBYp9NYF0BaiURmu6zCG4IWozyQI3JBZmPB+tB24cgho/whXErSxP6uOLcmu6SSxRpLOMi2wx4nE0hQqCOYzlJjLKvI/QyChyhFCv1ZjMertA37rpSG9JlSZuW/FNG3wOoJGHV+wp/YCCFhCJ/KKnpobW/X6vX6hZ4R+uzmF9yGS0jDg0Qwsko8xJl+lfgXdb9MBmBbf4s5viQc1478M06lo3cpBI2/jvqvemfs8ubo9N+l/3c+5VeVugf/eydHy+2kqanMwynsKqHADt+OZYFGJvw3eueefxt/127bX99+9U5anXfHn06vrnxd9sllLrIwjF6NfFynIpAnsnEbm8w7J/0u51hL+NixsPFRlKd1Ybxs1Eo6MBjmHGUxGKF273WeYPDOlkn0rSuMRAdDy3QN5oz43U36x4s9snTjhI0XMUYfeC86otK38fPmeJZrpjweNohLzhNW3s727uPbWPXdmO31UKWRmKyyc2UJ+b3GCDSgE3TJ8rGee3GBqleEUe1vyCmfbNulrkdgpx94Otqnq9Acidp/XP/qgP/+vjnCP90rjp3p62j+ag13T19f67cX87rv/3Svzubne2eDSf3F8dO69dPk9bZ+w2U5fq3FPI9weRi4ybUO0xNIeAq9sd1Cn3qzCzFThrekIhducJgBvh6Yf14oWumGX4KVPwkiXnPb9FfNeUw0KbBNccLErcczGZUXgJbnocD9aw+I4fMsNpr7R+slzpxk5bvPJZbQiQ2EYXu8yS3V3Cm231Tiju0naRhhm5914E//fNhb3DeOcWf/at//dQZvOtdwyurioNXRSEZ2o/lxX2RCJiE3elGSvbQiX4jFXd1CuRCCSbrage9PI9JwdjY45Bm+K6ELBWd+P1UwHQY4ukEFUtcRrJlZQbt1jPkuKxL6wrI6TSvannBpLs5EjNShI5rrMhZETg+sA9WFATxKaZlH6xDeHzfGZx/sKrwC0DRe4UN2HMcBCMeFbuxR/a4QgM2pRiuwetM+uSVqjkCyxmGJqq/InA/XaTzB5Uq8tM5hwGKDnEBm6V5jjP5QTyrOxFHl/lMFawZl9RVjMdAOhuJMa4JkB+KmNQFOhlZq2+z90azXqgg7RYqSI12u07RcijX6UYva2MuxEx2LGci9dHLhJiSTYlpzXqzbjeasFAPGweHjdZha69W3z/4bQWnMxqyqcghZkJedv3QRGh42I4swsR3XiX0DLdMG3Iey8vQW9XYyYr6CuOjICFwE+Q3DVNVoGmMy7Cu9n5A7aHmVL9ZjOpLBY2eDz+xzSzhMEfaG5r7ELyAr5qfB/d5UQNrVIkPbxeKGvHuTqG/3QG1djyhdtIp7GwK20xhS98uDNmJuR3uNF6/btT3X9WKfgI86slFSULDQafbW6X4xhtfnJzA00lnSF64NxhcgPclMyb/TNCOe0c36LM1rIJbTss7WoLaH2nerVrfQtStXKDgkSE6qjHMYjFMYrB8ZgJyPK6UAAlhUQaFQzW8ch8tRACA1T9d1+R3wGmSmZPyUKUgZLQMfY38u7r9+1GAQk5cnMpAqXWOT487lxnUTC0en5+GP0PFFlKdtPQHJLQ/5XL/y3QxbTg1Oom5Vyki1g7/dHEJfawWq3rLivx+/dIOi3mxIKh7vGhhVzGPkxVWlIaHpn3TgnZ+MTgDRr44y76kUWiazPnjifWw2+2MmpPOff+oM4H/jjvnR5PPX6af5ZuD+/pR50qdwLvk7Kp+373/9fjd1dXxhjz8hcWMAknx8+oXwcjZC09l4r0Zxb+V5v2W2V5Y0vm0yKPeSadz0e1cve6c9ftH3cnP8LvXab2f+Orr5W7z7HhyNBz/NPjnrt/eVAjiHsjTkFBGGV6mhXwqRfhzJmczyBrww1Gq5TR8s+6d9s/6w97xvwa964ubQbd3nScdfbdY1kvL1AtRnCmD6xEKHSwvBKpZTXt9bfDWajTbbegL/9u1PqJFiehOOoI+eC0Tfp595zL9FIOAAReOoDT106FZ/gG0mJZRurIqYO12ITBlge/NdZ4CpDoQytBC063qj1b0nW0W3JnPzRjIgF8BJDHN8NmZnOSxZrf35hr90BhiQjUVq+rWuSuvl4SWVlucSIC43c4KNuFajfHbDoWK8RRzc6MV9xx+65GLIWLLrr+26+1hs37Yfn1Yb9Re7+3+tj4/eCJkTEL3hejBqh4zM/x/E8e1+Tc0PWJre9W3IL0csV4Uwbphs0Hhy6reQ6D3QowCd44Clj6ERNJ9ybehNQUSV8QQO3QDVyzb1vJnQV/YoHYSMRSEsgMDGUC8ky5qL0XgGmSaU1C/UriCnKg12BF3gV5NX9cQg0yMuPMZYGm72YzQjS9hPEuHMJl/6FsxrdgXfLRXP2i2x3ttzpuv24393dHBmLda9YPdgwOcfSaUAtk97a3eCF9E4Oi9ACxX/hsYAmagTIpNk6/wWWtkQDCewf8hpWjYNyPT4MtwpwzEzeyoe8na+6D0/iSh93yywATfvrleUnGK4hHwRSQn0l+FShqvHcN6dHM6hDeD3tVN73qY1W3KyHZ8Ko04+GEVdWEa3JsckwhA01QCP+sKt8YqBmoFCOK+KnaU+knNwZZmaQoII8zsK0YUQbNxFMxKpmS2FbEfZU3UquBm4R0YszPNdyDRZomO44gwtk8NJytml8SrGutk0XKaoMz4HP01hNHamettRGDKYsF3l2WRs3LJ4WRhbEEoaByA+dN60nHiBJAjMotWmGmLQdHIB3DWnCtjNywwjViKn/wdoII2QzlBFFFVA2iTsWLGHdFXd3A8ftov81hFB0nu7kwjcxwH1ObwRD3D7i49cD82kZY13AljfLR1SHsjkkYqJuORTMpHg02vTFyp4et9AVvb3dru1nafabuLjQOzA8a0UujTWA59bnyeAH8jWjyXQp+ItMeHQNx00sGuFmQVs2wTIr19PwTD/iyoqk6FT/Fnxkd6KV9CvpPJo5A5ZcIqyQIRJD6aEjx4IuEeEt45xjpIJFa1lmc7CaKRBAX1V4SI4DUjNg8SqpJFie9TDqeqzA2E8n+IzcY6h/ZkkAfEWX3X1vWibSS5jSS3q9F2NfrbrEbbSHJru1vb/T5td2MkmWFF1mLiJJXMZjyaa00z7UgtZ9AhP+GQmRyJajFaQWAsi7GscuRgjZqNUWO874i2y9vuXutg3HT2mnx3v7HfGLWb+1Zxrb/N7TgzsrJNFeSt5UgsxgI0xHGJD8ql4iBwy+U/YG8kxujWqDadxs3Ac2Dpxyx2bB6sKI8GAW6AmacRkirFkH7OI/Rp0HeGfaO0LxXhJ+AXfTyZIQEvVCUstNoswu8DdPwDjRepwGNfc7szxtqrOVRilCybRfqOlwCG5Am8QG+DuOcy2x8BECiCnYB3/hOjUyOiPxTJswFSfIoUs95XRwg09Cxy311V3+37emMyu9YCXlPo1dkO90EBICHQPiuLO7fx+TY+367x2zX+77HGb+Pzre1ubff7tN1viM9NNLQ+PocOz47PoW+tzrJY6oR2MvzVYTqZisFA70MNHLrBwM1jcNpyAi9lPKdJbiCu72pV7kDQbg7cHeLGjljYeqcLPHFyQ0sN+siE9RGPlc4EaKi5/QBdE0do1o45VZEenqFTvhRpaiKTyINe6dbEB5A9yPyxxkNZk2ZnoR/c0/7EETB8hS/DTQfabrEDne/VE9RIWpFEg9Dek4CXtw1m+xI3QsZTQ6gU8yABf0lgqnhMxignvQYUQ8hMflDUu0bKuEQf0HUTeY9/nBYNaA0tq9i3cTbozwDTBRKRhI+5vlxjGK9nX9KafGnC1K+5NNkFdmuyI8Ej2tmKX0N+fPt++IpNMHgl56EPcQtJ2xg5uwQVIefYSb8M4CBar/IrLDqlby9ojGzsAcHMnKEv7E5lA3DzxFIcJMiz4KjnH/fmpXFrTsx/8G12LCN9Glzvvjck6lN0t2FKFy/Q9VIk/pFCszU0m6DhQfMSFpq1t+bIgQMeAUFwTxG3Xjy5hmcX4GFKBm8Q6iIOyAmDR/mLmZNK7cV4lODZCK+Mxwf//VTCylwexrTHwgNheG1EnznTIFDivxlD1UEzuJ0kYEUvRuseJ7XJIuxmvYCSrae0JZ7SIvxOwTB8rUz6SACFOQHul3O1Sf5OkgWb/512jv9eople38JyjD3dwPmGOwwWcMYJbZzQ1j5AGfz1aoeKhbvLgIbCiZduLn/yBAbRgt/TsFZ6dQK/Q2NwaXCCULsYFR7qh8PcwaXHK6gBe2d9wA1jmJ59Q8RjFwYWLnklZqUFhkUOLuPrBbDSLvBN45sVuHD1/U+jFynu5HWYC9+b/9leeo0n+c/xu/9HHm/raf6OnsYEzqhuNK3JMIpKfmTiteW6oKIzQPAXWslWKUaHDCi/zqgIKPR4jFpNVu1M6Y6ySISC05mfKmpWMCNLDPU1FsJc0zKhXc4RoMwhB5QeHvDBmnc6MyeD0YElyhWfVUJpDc7lTCFDFTX2HpI83wGxYIKHuzag7VNgMr1rkMwlCpYdp8KGoMscJ0K7TGaMg0o9oRGuVE6iHZc5DaRJCCj0y0alVoyqhiTUKNWJZupifK23wxcE/8RcIHdlKtXA+vzSACsnZCA80kzsVw7bn4IN2mZPhRfSWTNACxLGwgxn/eESRADmK6ALUvkgmuyYQWoH+wKQu+x2kFatUavblC7QrTAqhoSqAHzjPXa1RW18yEv1f/YNeGZlwcedEAtjtClepyg6F7y1lnJByC6mdPT91np4QOiYHD3ia31FFGaIwGTU/Pz+qbUU/f+6J28lw/FUT+EeQVOssCxMRZ/PyO/r0rsNjEjv9HshH7bX1X1/19Vt0Ib0TsIXasP2zrkVd85tYHd+rV/O8I95GQucOx6A07ZCnl4P0wXzwqilT8qlauObHq6ufE1+Y37gVI+P/wNMFQvu
|
|
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 'Retrieve all Managed Clusters.' (get-managed-clusters)"
|
|
---
|
|
|
|
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"}>Retrieve all Managed Clusters.</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/managed-clusters"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve all Managed Clusters for the current Org, based on request context.
|
|
|
|
## 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":"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":"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":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**operational**: *eq*","example":"operational eq operation"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Responds with a list of ManagedCluster.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster ID","type":"string","example":"aClusterId"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster name","type":"string","example":"Managed Cluster Name"}}></SchemaItem><SchemaItem collapsible={false} name={"pod"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster pod","type":"string","example":"megapod-useast1"}}></SchemaItem><SchemaItem collapsible={false} name={"org"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster org","type":"string","example":"denali"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"ManagedClusterTypes"} qualifierMessage={"**Possible values:** [`idn`, `iai`]"} schema={{"description":"The Type of Cluster","example":"idn","nullable":false,"type":"string","enum":["idn","iai"],"title":"ManagedClusterTypes"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>configuration</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
ManagedProcess configuration map
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={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"}>keyPair</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
key pair for the ManagedCluster
|
|
|
|
</div><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"ManagedCluster publicKey","type":"string","example":"-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----"}}></SchemaItem><SchemaItem collapsible={false} name={"publicKeyThumbprint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"ManagedCluster publicKeyThumbprint","type":"string","example":"6CMlaJIV44-xJxcB3CJBjDUUn54"}}></SchemaItem><SchemaItem collapsible={false} name={"publicKeyCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"ManagedCluster publicKeyCertificate","type":"string","example":"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Specific Attributes for Configuring a ManagedCluster by Type
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>queue</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
ManagedCluster keystore for sqsCluster type
|
|
|
|
</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster queue name","type":"string","example":"megapod-useast1-denali-lwt-cluster-1533"}}></SchemaItem><SchemaItem collapsible={false} name={"region"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster queue aws region","type":"string","example":"us-east-1"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"keystore"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"ManagedCluster keystore for spConnectCluster type","type":"string","example":"/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster description","type":"string","example":"A short description of the managed cluster."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>redis</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Redis configuration for the ManagedCluster
|
|
|
|
</div><SchemaItem collapsible={false} name={"redisHost"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ManagedCluster redisHost","type":"string","example":"megapod-useast1-shared-redis.cloud.sailpoint.com"}}></SchemaItem><SchemaItem collapsible={false} name={"redisPort"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"ManagedCluster redisPort","type":"integer","format":"int32","example":6379}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"clientType"} required={true} schemaName={"ManagedClientType"} qualifierMessage={"**Possible values:** [`CCG`, `VA`, `INTERNAL`, `IIQ_HARVESTER`, `null`]"} schema={{"description":"type of client for the ManagedCluster","type":"string","example":"CCG","nullable":true,"enum":["CCG","VA","INTERNAL","IIQ_HARVESTER",null],"title":"ManagedClientType"}}></SchemaItem><SchemaItem collapsible={false} name={"ccgVersion"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"CCG version used by the ManagedCluster","type":"string","example":"v01"}}></SchemaItem><SchemaItem collapsible={false} name={"pinnedConfig"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"boolean flag indiacting whether or not the cluster configuration is pinned","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logConfiguration</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"}}>
|
|
|
|
client log configuration for the cluster
|
|
|
|
</div><SchemaItem collapsible={false} name={"clientId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Log configuration's client ID","type":"string","example":"aClientId"}}></SchemaItem><SchemaItem collapsible={false} name={"durationMinutes"} required={true} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 5` and `<= 1440`"} schema={{"description":"Duration in minutes for log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"minimum":5,"maximum":1440}}></SchemaItem><SchemaItem collapsible={false} name={"expiration"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Expiration date-time of the log configuration request","example":"2020-12-15T19:13:36.079Z","type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"rootLevel"} required={true} schemaName={"StandardLevel"} qualifierMessage={"**Possible values:** [`OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`]"} schema={{"description":"Root log level to apply, the default level for all logs. For more information about logging levels, refer to the \"Logging Levels\" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"title":"StandardLevel"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>logLevels</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107).
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"StandardLevel"} qualifierMessage={undefined} schema={{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"title":"StandardLevel"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"operational"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Whether or not the cluster is operational or not","type":"boolean","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Cluster status","type":"string","example":"NORMAL"}}></SchemaItem><SchemaItem collapsible={false} name={"publicKeyCertificate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"Public key certificate","type":"string","example":"-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----"}}></SchemaItem><SchemaItem collapsible={false} name={"publicKeyThumbprint"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"Public key thumbprint","type":"string","example":"obc6pLiulGbtZ"}}></SchemaItem><SchemaItem collapsible={false} name={"publicKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"description":"Public key","type":"string","example":"-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----"}}></SchemaItem><SchemaItem collapsible={false} name={"alertKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Key describing any immediate cluster alerts","type":"string","example":"LIMITED_RESOURCES"}}></SchemaItem><SchemaItem collapsible={false} name={"clientIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of clients in a cluster","items":{"type":"string"},"example":["1244","1245"]}}></SchemaItem><SchemaItem collapsible={false} name={"serviceCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"description":"Number of services bound to a cluster","type":"integer","format":"int32","default":0,"example":6}}></SchemaItem><SchemaItem collapsible={false} name={"ccId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished","type":"string","default":"0","example":"1533"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The date/time this cluster was created","example":"2023-08-04T20:48:01.865Z","nullable":true,"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"The date/time this cluster was last updated","example":"2023-08-04T20:48:01.865Z","nullable":true,"type":"string","format":"date-time"}}></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\": \"aClusterId\",\n \"name\": \"Managed Cluster Name\",\n \"pod\": \"megapod-useast1\",\n \"org\": \"denali\",\n \"type\": \"idn\",\n \"configuration\": {\n \"clusterExternalId\": \"externalId\",\n \"ccgVersion\": \"77.0.0\"\n },\n \"keyPair\": {\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----\",\n \"publicKeyThumbprint\": \"6CMlaJIV44-xJxcB3CJBjDUUn54\",\n \"publicKeyCertificate\": \"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----\"\n },\n \"attributes\": {\n \"queue\": {\n \"name\": \"megapod-useast1-denali-lwt-cluster-1533\",\n \"region\": \"us-east-1\"\n },\n \"keystore\": \"/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW\"\n },\n \"description\": \"A short description of the managed cluster.\",\n \"redis\": {\n \"redisHost\": \"megapod-useast1-shared-redis.cloud.sailpoint.com\",\n \"redisPort\": 6379\n },\n \"clientType\": \"CCG\",\n \"ccgVersion\": \"v01\",\n \"pinnedConfig\": false,\n \"logConfiguration\": \"{ \\\"rootLevel\\\": \\\"WARN\\\", \\\"logLevels\\\": { \\\"foobar\\\": \\\"WARN\\\" } }\",\n \"operational\": false,\n \"status\": \"NORMAL\",\n \"publicKeyCertificate\": \"-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----\",\n \"publicKeyThumbprint\": \"obc6pLiulGbtZ\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----\",\n \"alertKey\": \"LIMITED_RESOURCES\",\n \"clientIds\": [\n \"1244\",\n \"1245\"\n ],\n \"serviceCount\": 6,\n \"ccId\": \"1533\",\n \"createdAt\": \"2023-08-04T20:48:01.865Z\",\n \"updatedAt\": \"2023-08-04T20:48:01.865Z\"\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> |