mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
85 lines
28 KiB
Plaintext
85 lines
28 KiB
Plaintext
---
|
|
id: create-role-insight-requests
|
|
sidebar_label: Generate insights for roles
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21v2zgS/iuE78O2ReTI73a+HNwkXXiRbnJ5QYFLA5SWaJtdmfSRVFJfkP9+M0NKtmyn7XWLu23hD9uNpeHwmfcZmn6s6YUw3EmtRmntqJYYwZ241JkYKSunM3cp/pUL62ztoJaKhREJvAZCZ3JxUHN8amtHtzWkZ2GBrd0hqU2MXCBbYHqVj+fSWcaZZ88M0stAz4zfgjnN3GzzJV8sMpkQwDobAtFMWubkXCCtEYzDf0qzBTd8LpwwFqiyjI1zK5WwlrhZ9iDxmWALoxN4KlI20YZ2S3Lr9FyYOghohF1oZQXI9Fhrxg383y5JQAMgSxXnVKigx0IeYJho5YRyyGdNjsOPFpk91mwyE3OOf7nlQgB7Pf4oElwIOMEsTnooMl2jsc5INa1t6jjYiY28aFV4u9GJT3y+yJBnP2kMYtHtRf0e51FbpIOID+JxlA7STqvd7jRbk3Ht6SB4R3oC/+xCBBvPOUhbS4EgQiNtwbwGlZdvn/GDB26Do6T1Csxm3IyjeBA1uteN/lF7cNRq1hud+J8ILePW/eqlFDvV9T3BaQT0BXid+Kixgqfy+ViY88nNAjewawAluMhUmG0w2vGM+XVMT1juVwbHlSWiOrty3Dj0cTdjMeMq9e4+4/fg3tpAzLqCz8NMlB7AgMfx+duLs9Pr05OKJDEARulHqd0OgesiREcnEIgz7igEpaqCAnZBPm4MX8JH6cTcbhvmCfayjrt8x7vnfDzQA2IQC/PP8eXpEISAJ6Pf2cXl+a+Xp1dX8KkUD/5+MxydwR93uGEpqY+tWjLgPG5OwP+74zhqj5N21G+P06jVaHR5t9FqiF6vtuH+z3vjljN+jnTLMeI13d/Wmsmg0Y/7oteMxaA96ceNXrPTavZ7Sczb7UkbOASSXq/Z4kmzHweSxqDRaccibpUkg35XtJN+ZwCprSu640ZHcDFpt3sJpuzCCKUyQU9OOvLstXpgL0OSBMuhKttxvO0jx5mEtMdOjQFnjdilcLlRkDTlxGf4YMexTpfohVLd80xSNH2njJkKx2V2rNOdeaoK9g0UimhquESEgiAnsBBrxb1MYQWba/BwzxIjEUUgumr4gybqDfaap6zw0+MgDGrS8OQP4DX6ilR+oySsZ8USJlfVase2oif4uBsPmu1Jt815s99u9DrjwYS3WvGgMxjg7nOoeXxaSTtFWFa3JqeVCct0Ahb5NygEXB50TwBo8x2R/IwNiMdX6B8TiqctxQx4mROf3AHUstfHF6zdYxlX05ye8+mGElR0c0XRlGV8jI+wQcGyQIzPjZxKtQtKkUFOTt8Mb86u4cnl6T9uTq/gL+S11coMFXhrim6pKSvP9AMhDgJgdbAiA3VAcWCvAtdXIBBXdp1Q+k92aUGZ4FsTnmeQyl+F3XesWGfNJkbPK6FEcfPJsReyLuoH0OrAMyh3yYyNObY7WhH5q2GSiIWLzoImX7GZ4KkwL6FrSlOJQkLRgWgEprB+iT0TT1MMXc9gkkMoC6o1Ooeyop1MRNUWK1VWrbFKJ2frRsHgAORf9pNh4nIAR2KuR2HpLQFisA9g9pqrorteUxqpdKkcT0AKnmXLslyOQTbsWEM6QnNZSDyqoCsz1tNalqR099aDOXGa3iU8t18RdxcZpJ+IRCtf3IsQfBY7Y5+NyBqFmUJGCm0zLQ5UpbmKwGcTKbJ0H7v72N3H7lfG7ubLou8Jb6n12TEh3iieg34NFc+t1seQ98C8WhD5mcwb8oCBQkKL9Nu7awjsP6BbB3rxaSGN+J79kS/lW+CHpT388zG2H6WxKrZAgKRHL8EEMpFIjwj3CjEpyquqtb3bG23GEhxU7WgRIWsattQ5DRcmVwqRcHvAUi2s+sX56YYnOM37DIi7qjRaaBio9p3kvpPcV6N9Nfp5qtG+k9zH7j52f8zY/WwnWaKiaAl9ks3nc26W3tPCe5SWMyBgxdcUrAw5MtVmt4LMWNlj1aqdQ23cbIwbk14i2ilvp93WYNJMuk3e6TV6jXG7icedq1p/u4rjMsiqMbVmb29HUjE0cffQx+UKnMs6rdPq8R+o14gJpjVMPWXfDDoHld6VvWNzsOMUWmv2lqtl0SHZSg+pVjrCnAa0c6Q1BS0QcDaFvKgYpCoJuNCV8NA/YnhmyzI5lxS8KAXwNctoOHEgig+UwsnKXaRKshwQUibINHbNGhxLgpBigj0fcKAOdgrZ+Tt2p8FEf6qTZ5co8RlKzE4/JUJgoJede2fX+e4IwBvMEVfewM8c9PpphytwABgIfM4q+859f77vz/c1fl/jf44av+/P97G7j90fM3b/i/48dEPP9+dA8NX9OdDWY1b2Um/Quf7nbTqFSkBA7s10kuSGjpuLHpz6CnAlBLTQdHdowd0MPh3iVYWouCRzaFaXxXzr70HlJgPamXMLe3R4+Ai2Ahs91flC1iGFgbncUumHeqLnh2NQ0I7cg5cEfJwhARtejMJsUSftGokO7LMdMfe6JnnQVUHndC78Wc6Kz8mIS51DfiM2BwycPTgTPcabPzBJ/GKJuk7OsyUfyHVjsqc/L4tn9Iwsu9T32d2AngHSDRFRBLz9IcDowIjsdQN4jn2qGuZo59u7dZorbM09wi3KVbnBca65BegcyZrsteAG5gb/DceL395dvyyuqEFCwKt7UyYkThAQUhfgRpTwhsVpPy6iGmR0Pp2RcMPK9ykYYGySgVLYe3UlBLsdBUX9DpXgElI3qR0XCcoWuOruRWHBVNyLDItkfaVtdE6ZqkPQ4iGvrHtJBZEmB6n8LTO8rPheRexEYp6SWNiRpriFh4Mgu10UcvE1ub4VxN8KbpHnFhE3+3IDhVftbeLv5yQQ5ciCZ5a09c2be37RGj8cs+AJct3EgJoIOKrfgiWF1b4ZR4VfhPyqON6rdzMJ1ba6jPnkxiwUyyxlI5bMtLbi74yh62Co3E5ziLRvhvWAm0YUEVEzXoMU+S0jGUHvSPjOIDCUdyY+xtpNrYuGrk6lPmw/kGUhL3ygq34fKjLT41sosUiZ6sR+M2bcMMINI58nbMDvKxg6FsQ2ykB5wDvA8cr+lAkC0LXc6HntzPzE/pDWYPlIACpxsYsj/+FolQTDX4xeIHVJA6kaW+/ye0H4zAIvLGMVZRWHBpsa3MabaaieG3rzeMtDK6yofzV5UeLh6mzlXGXL752ln8kkf528+3/KePtM8zNmmtAMo7vRtmFqWHfy16Gn2z7rs/STBfgX3lKsUt8NU42/uY1dzDqjRcYdejVFdTKTgk4JFoI77A8P0LP0nCKx+FFDuAI+pVvKBiBzmOtkBvzoHLvYOVzXpuYT7YqfbU6jCu6VzGDqFHX2DgY3lYBZcGjDmxjw7qMO09sVWOYCDctOCmND0zWf5wp2w7jM54yDS33BI1Jpk9wnLpjhlCh0oan1K1cVUYyuhiLQ7XJh5vZ8ggfQMNuuGf4Le4HdbTh9BtWjFbGTx8moFORSZOSZSFdt7b/EG7wtmolsQT9IAFh4TXq1w9vR9RZHYKYsyAXjuTbTw7DIHiItMMERyrtPq96oxxGNFPAcpzAYdNeYF9fNV79YwOxIv37ZdMXH1dn7D/PTnFCvcNA4XOARGmoh98ORn0Vva5VZtIY/5wnTKMwuMxxbgebxEU9acDx7wsdAgGP87d1q8qJpBxbQiQuNQ38ImvTpTGY1zG9/a4EzUjknX5xfgQWf/gMNu5pv
|
|
sidebar_class_name: "post 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 'Generate insights for roles' (create-role-insight-requests)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Generate insights for roles</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/role-insights/requests"}></MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer.
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
|
|
|
|
Submitted a role insights generation request
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request Id for a role insight generation request","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"createdDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was created.","example":"2020-09-16T18:49:32.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastGenerated"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was completed.","example":"2020-09-16T18:50:12.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"numberOfUpdates"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The role IDs that are in this request.","type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `IN PROGRESS`, `COMPLETED`, `FAILED`]"} schema={{"type":"string","description":"Request status","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"c9aa02f7-86b0-4bc4-84bd-3116a6131e77\",\n \"createdDate\": \"2020-09-16T18:49:32.150Z\",\n \"lastGenerated\": \"2020-09-16T18:49:32.150Z\",\n \"numberOfUpdates\": 0,\n \"roleIds\": [\n \"2c91808e720e94f8017253287c0a44f4\",\n \"2c918087723ac2800172532191540e03\",\n \"2c9180986e4c8592016e6b15eaef447c\"\n ],\n \"status\": \"CREATED\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |