LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-org-config.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

95 lines
39 KiB
Plaintext
Raw Blame History

---
id: get-org-config
sidebar_label: Get Org configuration settings
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2rgW/1c03A/bdmJCCI+Qmc4dAiSlTSDlkUfTTlbYMiixJceyk9BM/vd7jmSMgaRN253dux2+tGBLR+d9fkdIecjJgIU04lK0ndxubsyibjhuSOHycW4jF9Gxyu1e5OAZSR5+2cgpZschj6bw5iE3VCyEVxG7j+pxNMHR3BG7Mhxbtp6hdkNGHSC2/Ningo5Z7ssjkHSYskMeIB/AxQGLCIwkZmRs+CN3PJoQKbwpgbVYKKhHXuEo6vhcvCbUtplSfOQxEoQoVcSZIq4MSTRhBDgOmdBk88BLyFQghWIg3UOuWCjgf4s89NhNzFREVAx0mcMcnGajoCLC0TQIPG5rzjavFE55yCl7wnyKn6JpwICIHF0xO8oty9ccdIntUWXYSxVOHBrRrByjKfCtIumzcC5zKjJ59TnX7R1c1ptH7c7n3GsSgykULDYXH1mB8R3qswxXKgq5GK9wNQA1CRhJpKtVlqiK3VM/8HAetX1mKenRMPcIvsF99kmKFxJWzANNMIfgNPIV5pG7CbcnhCsSSTJiyL2TmgvXJmQwgbcOD2EmWJ26LnxQMI8Jgqp2Yg8JUnWtCA0ZqAgcE9aAmSfU4w6RmgNFbCpwBVfGwiE0IpsjFtHNuS9u3uJwC1mzkDW1IHYd1A+W3hzIEMwvUXbPVo0JFWP2TgoZqr6MQ5u1BAWj7TMaxWFWKyMpPUbFilr2PTpG2R0GlgV7okYYCG80cNjoXzbe1TsHrct33U6317/sd4e9Ruuy1anvHbYu91v1wbDXIi5SATUxvbrznMOn4rjUUwxEoKHfSHwLI/97Nqz3jshsPGk34b2IPQ+XzO1GYcyyCmu2tnda1XLdKu/vV6xSvVK2ys1G1SrsNCulUrGyV6i1coaFPg36UxUxv+0cQUTByuoFvBCPQ2SCm7abnd1dpbXfdlCXwCY8SCgSPyGZ/xa7kMNmFIB20a5t7RR27Gpti9ZKrFzYqtaK2zs7o4JTKVbKNaA0Iw+jt8rlCkiySOHyx2gUL5+isv2DVLYTKl+MXk0qfolRKYwEP0lSGUlHPm9eFvDzzqB3Xi/2q+qOq+bp9dan29LJUWd8e9O64nuT8mXsxo1T5dOib5XP6k1+dbM3LvCrs8PRtCz6Fe/+U+eMjiYHon58wJoHdulk++rjh3Byd2IN302D3qHa+XQ47l7xj51Y1Trc7xfiY+eD9HunlcH+6c3Z1BXnjvVVdMaj0Ul8N5zWDqbNGhs1T973RXRMVXTfv68O7elBfLp343Y+nQfx/YfeKbusDk7OK4Wbw3L5angz/brTKZ0NRyPHvndGnwoxv67EkbV3WyscfRiMPrH7vdPL417pxh63r2lLla7bTBxO9+7FwVd+Lqv1biF6vzM6eNfd2X/fu+ajRlD/2I6qx+3+oawejC/P3NrVVsH5cFM8b46npeB4cPt1220VP707F2eNs9uz/X7duj2h47dvk5Bojl5mOCwWI6pMzv6mwVrDWbQpOQy9l5Hv97tk2Dv8JuFJFAVqd3NzCn5rAX1LKWnFsAIsxyk3CbGBpchN/KvHbOn7TDj6m/qlLNmut8kCcbJE3RSF5/NiNi2iaMC1kk6PBTKMTEXOMkjDkE4RxkDIqadq/GLZtaUX++JllbeTVF0zh0BpDzUTC2Wo322SvViBBgA3aLqPiGNuYqiPzgsU2YaqjvZLV1FkNhtXpJ6XrKo2CIU6GU10VYnCKQ7lvh9HqMk8qZNSoUBYGIJG77iepmIvIm4ofZgJhToCFQURWs2XDnenRvF62T+goDOXC45c5ZctgDy7FIjN6xQXthc7PyvhbDZKiEwYCZ+QAeBBNAnlHcxyQYhUBqDhU4ehLApQ6YzeW80ejp3p8O1bXHu11D4hkgwdFmbk4QAqx/BkIwdO6tPIPNouwgNweO7Hfm63AJ/pvflc3CpVSzvblVJ1WQM95oHr3wLcAimJXmfu+FopecDx+L9KxXa4Cjw6BR15zI2sSFohH09QVCKkcJgN8B28bmzILQhYfNQ4MNL+mY0bALi5x+zLeVPxqJ+XnoLcDY9jZLa0VSyIZgBSAm3nJrYziHwkHeOSQsO2X8LlizELOYZyryGdF8TsPgSiNQ4pRw6NI9kwEXuPW+6gvnwJ6ceQnEFqPW4RVIMm8ltkjzpk1nE0EmFQfSG1r4HWSxDaUHCYT2ZTCJ/nvCeWZVVGR5VCrVhyKyVKizulrWp5VHPp9nahVq7VcHUfMg10aE8lweV+TSBEJp60wSJfQSHoM5CQkQG9+MvzpqbxwqbCjE3FTPgl2ItCDiN7jWNSqhIPgHqsn9OlhoYJa9hfqXCI7zXhLgQCF0+xwgTG4QUg3f368HAAT3qtj8NWHz4hrZWGto5J3UG3BFbBFybyTnOcCHBHVdog5cmbhOobEIhCoGYGcvPN4D6SJBaYkaz+xIwsaZOhs6Fkm8advOJ5lt+AbADPIAFBW4bIAhookzXf1KEnDSLrMNHkGzKBlp6FryGROo5O5dCYQjQCUZg/xbRCnUzadWPsiXQHL+MI8grgzcVcmVHlMt6Y5ZDDrFEwOIDzF2AZO4qBOS1mNgpTb0lYTOyDaVCvs8jdIKM0rdKpiKiNqNmDztSWIfaoZASycehQk3SE5lKQeMRsXJqxsqlRp7sjw0wT20t4Z9NYvSDujj1IP5YWLX1xy5Lg0321yUbaGjMzJRkJXqLYenIyKjXXLPCJy5nnrGN3Hbvr2H1h7C6/7CUbjclbDX22VqHPUGAfLkNdPFegT6i9R0gyG2TaHWPIDQBmM4j0/nQAgX3NNPZl9wEC078QH5lSvsJ8PbWHeT5C+JEaa8EWyKDWo5HAhUzEnF3N95xjrSijqu3V1fZlOOLgoOIJiIg7oAS6Ud35hbEQyAmFhsaRTIk/IjKhkB/NDqvJgLrHcaxAAuJeI8k1klxXo3U1+n2q0RpJrmN3Hbv/ztj9JpJMudLRkuAkFfs+DafG05L3KC0lMIDMfvImachpUy2jFSRGUoyVW0QOuVFxa7TlVm1WcmjJqWzX3KJdKdJydau6NSoVq7lsrb+Yx3EaZIsxlbG3sWPyW3F4CzguFuBcKpLSWdz+A/WGzMW0hqknxc2g8zz+/pVix9IqduzICGTDX4EtoPH09uKwd4j0YWlNHvWmf5ZDmG1UB8NppCEl+jBomqtoDR3X0HFdftbl57cpP2vouI7ddez+O2P3h6Bj6XvQsfQD0LFEEGLpg3b/JHR0AHcgNHM5HvhLz3yELABR4FOy+5iEfUTDMYtSoLeAIou1VRQ5kJIc4UGHBCyphZ1IMVcXpjcY6+PYcDYWz1qQMaRIQSBrcUC36FV4KhIwKfgP8bjPdRyjQEA3nFp1NwKpTMzMjzIkqyRnEpROCp4U+rjMHeXgTsxF+AcU9D7oGBL1X7jHmVjrl/aDSQ8lPkSJSeveHLQl6f5v+alTAm2RHITtG1s/c1zA7JlTAW0Euw9M+koh6Bqqr6H6utyvy/3vUe7XUH0du+vY/XfG7g9A9QQNPQ/VYcCLoTqMzRdIiqX29QnVvxux61BJONDuTaStsbozx+AaV4ArJbfTMIdQvNuQy9zfyeGdNASDhg88gT4/nP4A5gGzPOZpwPOQtcBC0VTIu7wtfX0R6Il0g6dLTWjhAFI/biedRV4rNOTosybBaeJGvckx35wCNesDBd+kPLtqhYfniSGzQcC/E//Rj4HFAJqHP5Qendf+siIfyDUMvcdfl8UQekaWp9T3zdVgPAFOl0REETJXCPuItM3qKxcJ59UD9/iLK4t1cViR7DEa4p0pfezl1fvTwWsyRnyp4zvWJ5cZx4YAIuQYXETnr/rsCAhO0iUllPF4ohmvLxyywXghrgcCk8+izxi5aCdK6EBi70Em1iqtL1yj+fJqZh2H3TIPa15+rkl0PO6ITdDQ5uL1m9e6vulGgAtzGByPyX8WFmnqa3D6WgOOSUTUfR25CGZy0YxcP8vEf2bULEPN0tTU6yUujGovbHNo24agRRLUU1pbP724oWdl6GHXBE+Q6jIPqImEj8WjUfbMaj/NxwI9C+kt8vFZnOr7i0v3p0yuIgpqn+eQNrEnUir2X0LQdTAMLsYxRNFPs6UvTVo6IqxiIcOSZZa0uAVQUPN3CIEhjDPREZZijUSk2RTRIfmntizE/J/6xsefCzLrxxdQMXGkI2310zzjgpa+I2RygEr4NwUJHQtiG2UwF2e0AzTm9teZIGE0k/cMrSezuia/qedgabCBVU1FBbvmy+48wSWfiH6Bo9MxkIYRSaeHxfCGTEILq9KCsmZ7AMsaXOXXk1AMl/Rm+E1/ycQC+f8mL0pcn2+VdIU3/auz9DOZ5P8n7/5DGW+daX7HTJNgW3Q3vWzSBGSdfC/Ba6tbd7i3PGHwL7zVsaphNDQp5o8kIIrJEgo8GqFX66i2J5zppj9gVN/o20DPkr6OROjPMfyZMoTGIYyBsFWASemIe0BPb0vPVqY6YAywRLvidxUnhyQkuCTekc+TU7yGaYNZsAfD47nw7komzVgfLHOMhiXNmbEBdPl+LGA1jMvYxzv73/MIhys7NokLmgLBZrqQGvqls2ZRjK6GIuR1NxL6quvifjK0qhnDf2ctsLtKNpNB9WhFfRUXGp1UEHMhD2+6bizB9u/RBm+zJswL9J8bALagp8uscNQerFAEYiL5BQNao81kktrEsUAE2yPjPtv5rXzB0u0CPA+kiqBvzRDHP7/RXfnzG4pFkb6fv+SND/Pd9L/hD3ckxQa7hM0At7NQhNh0LaYxvMhlGkNoNSYgHz59eMB9DuyUHvEx9PfYRF98mTdB+A2omf0O3UleM91n6x2ReSu9+psBtjRpl3rQQtvQZ6pj8gGXenz8H/KQN5Y=
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 'Get Org configuration settings' (get-org-config)"
---
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"}>Get Org configuration settings</h1>
<MethodEndpoint method={"get"} path={"/org-config"}></MethodEndpoint>
Get org configuration with only external (org admin) accessible properties for the current org.
## Request
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Request succeeded.
</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={"orgName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the org.","example":"acme-solar"}}></SchemaItem><SchemaItem collapsible={false} name={"timeZone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones","example":"America/Toronto"}}></SchemaItem><SchemaItem collapsible={false} name={"lcsChangeHonorsSourceEnableFeature"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"armCustomerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM Customer ID","nullable":true,"example":"DE38E75A-5FF6-4A65-5DC7-08D64426B09E"}}></SchemaItem><SchemaItem collapsible={false} name={"armSapSystemIdMappings"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A list of IDN::sourceId to ARM::systemId mappings.","nullable":true,"example":[{"sourceId":"2c91808c791a94e501792388b0d62659","systemId":"1556"},{"sourceId":"2_2c91808c791a94e501792388b0d62659","systemId":"2_1556"},{"sourceId":"3_2c91808c791a94e501792388b0d62659","systemId":"3_1556"}]}}></SchemaItem><SchemaItem collapsible={false} name={"armAuth"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM authentication string","nullable":true,"example":"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag=="}}></SchemaItem><SchemaItem collapsible={false} name={"armDb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM database name","nullable":true,"example":"EU"}}></SchemaItem><SchemaItem collapsible={false} name={"armSsoUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM SSO URL","nullable":true,"example":"https://your-arm-sso-url"}}></SchemaItem><SchemaItem collapsible={false} name={"iaiEnableCertificationRecommendations"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag to determine whether IAI Certification Recommendations are enabled for the current org","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sodReportConfigs</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"columnName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of column in report","example":"SOD Business Name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition.","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"included"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"order"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.","example":2}}></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 \"orgName\": \"acme-solar\",\n \"timeZone\": \"America/Toronto\",\n \"lcsChangeHonorsSourceEnableFeature\": false,\n \"armCustomerId\": \"DE38E75A-5FF6-4A65-5DC7-08D64426B09E\",\n \"armSapSystemIdMappings\": [\n {\n \"sourceId\": \"2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"1556\"\n },\n {\n \"sourceId\": \"2_2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"2_1556\"\n },\n {\n \"sourceId\": \"3_2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"3_1556\"\n }\n ],\n \"armAuth\": \"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag==\",\n \"armDb\": \"EU\",\n \"armSsoUrl\": \"https://your-arm-sso-url\",\n \"iaiEnableCertificationRecommendations\": true,\n \"sodReportConfigs\": [\n {\n \"columnName\": \"SOD Business Name\",\n \"required\": true,\n \"included\": false,\n \"order\": 2\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><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>
Reference in New Issue View Git Blame Copy Permalink