mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
83 lines
30 KiB
Plaintext
83 lines
30 KiB
Plaintext
---
|
|
id: delete-bulk-roles
|
|
sidebar_label: Delete Role(s)
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW+tv2zgS/1cI34dti9ixHcePfDm4TbrIXrrpOcn1QxJsKYm22UikjpSSeoP87zczpGTJzqsP9HYLo0AqS+S8Z/gbirpt6FQYnkmtDqPGXiMSscjE6zy+muhY2MZWI+Mz29g7b7jfl1swxIZGpjgFJpzOpWXj94dMKplJngnLOAtgPiNSMIjpKdNKMG1Yoo1gRKh1oS7UmGX6Sih2I7M50thix5Nf/xjvvzv8fYtNjo8OimuYSj9Pzl7THcbzbK6NzBYMuBvx31waEQE1FvI4ZpmXqcUOFeNRJFGMLZCrwu4heglfgLTxok6JySnD3yQ7qBrGeQQMpYIRggQQNmMctOPW6hDtQOKc6NyEMINYJlzxmUiEytiNNlczo/PUonVu5jKcE6W6VBJtmYgkEKYFnvBsXuto0di7bRRqN/Yyk4utRqhVBrTxEU/TWIbk1e1PFv1027DhXCQcr7JFKsBzOvgkwgzopgZjIJPgXiQLKh5GdFn39JEEFUHaw30S2pkCdAyEc7WIUEhPnBvDF/BTZiKxFaY2M1LNGndbDfGZJ2ksMLS64agzbA97g2GnK9pBp92Bq0F7tzPqjEQYcqDjhwz9kC4NEZ3uaNrZ7Qw7/cbl3d1WxSTnpR4QsZnMkBGFMIb2Pok7ceasyVJR/3zJs9/bGQbEs98fBqP7xKIhfEhDVsRygtlUK+ss3G131607EVluFDgc8oUc42IGg0JGaG+8yri9YuCrqTYJmJHuOduzMo3RCV8dCiu5jexA9DzOWmtx4qauOvYREmz/9JjhaKQlVJ6gjU/HJ//6Y3JwcnZ0ip4qHVF7AAaU0ZfxOtwnLiW5Xr/HxSCYDkYd0RtNo2DQ67f7vCt6fDjq7+wiD8WTL9QokjaNoWDgTOSn8jjmATJ0KVnyxwcYB0UkIpEJ0djP9EoEevZVAzj9n1ai0MGxQ4a9dns91t7EEovQgTFQWJvMhR6Ws2mtnAVQaLAGSXXNYxl9U2DVYycSGZfxGx09w95vpRLNmeESJRQkcggTGVC8lhFmAa0qjmSRKDRuJQLa7VaHveYR84nP3nhl0C+Gh1dA6/AZYXamJMxnxRRMT8jHh9iKgeBBvz3q9qbgPd4d9jqD3WA05Ts77dHuaITcE2EtrAzVOlnUzzrrX4USRoYs1rA6yT/BIEZwsD0JQMzvKbkP+IBoPCfeQS83tlTTy8sy8TnDZfX1m/esN2AxV7Oc7vPZihFU8+xkLT9Ac0f42MiZVPeJUpSJ/YO3Y5cIk4N/nx2cwBXSWkMjYwXRGmFYgqgQC3N9QxJ7BW64ZRbqZYiLFXvlqb4ChTiU3spA6X7ZhQVjQmxNOdZA9spzv2dGlTSbGp3UUony5nPGXsiWaG3Bkgn3Ep7Bqh9wCxO0AxKvxmEo0qx55C35is0Fj4R52WJjD2N4zCAbgSghFVh7Ad8skcg0h1QWtHToPGNKZzIUdV8sTblarYridFR1CiYHSP50nIzDLAfhSM1qFpbR4kX0/gGZneXq0p1WjEYmXaiMh6AFoC/AZNoYXBoD0E1mlvlyhO6yUHhUMa6sWNWaS+XunROGqi48C3lun5F372MoP01SrXxwLXzyEQhy1UiUaBMs4SsSPKSlGyf7UaW7isRnUyniaJO7m9zd5O4zc3f14cQj7Dqeomx5eOW/B4U7KpQuAY/qQaAwE8mDqyDmER51cNHoCN7hURgMexHv4f+jdqe3K9q7g97uYNATjSocOF+mepmH9bSrhIRz9Xf3wqWHkaAe9k8AdyyLZSIzdi11zJ3h1uz4wEhWNELfbsjBgAPq5WF/2ha9bjcKwt3hcNjv8yDsdgMx+mZD+k4QTJSDgcTnUAjM1oR/9lpBpuy2XaRAU9l0jVjNYq1euwd6TIURKsRS4To7SG2YlqvovgB8cPAzbfckzx9tx4oshUnPL55sri8alxS+pdzOsEVX01k33ZnyuziIi9e6GkMLg9LFVs+fLh5djaYdJt/9/Pbh1O8TwXjxOcX9hO/Y+jiUvib8uCy17n5QtPcFql+WWRSQktNpMAX/i2iP5F5K3Fiaamed21ttAglrj7qn+wNAZNhC57SbZXKlUBJut1ikhVW/ZGzOAfpwWOysdeAGuaqomWqpsk2TuGkSN0BzAzR/HqC5aRI3ubvJ3b9n7n5Rk0g4yeZJws3CRZp/jtpyBgNKBM7KlHsIiO+wEmOtAu6g2wk600EoqAPs74ym3bDf5buDzqAT9LqD79IBAoi7BhwHuFkYm2kd1Xf2wbxGTLGsYekpcTPYvAazu6N17HiqNXvH1aJASLaGIZcdHtU0GJvgWFOMhQGczaAuKnyPJbV7tSUTAVQMBI1rrTB5UQugaxbN8TQDVVyiLF+5ei7+XaylShBrRM0aAgvas0BMEfMBBUKwM6jO3xGdehd9E5JnE9T4iJrJg6K/LJH77n2vbg5BeIM14sQ5+IF3OK7b4QoCABoCV7NK3LnB5xt8vlnjN2v8z7HGb/D5Jnc3ufv3zN0vwOceDT2Mz2HAs/E5jG21WYml3mJw/XCYTqniJaDwZjoMc0PbzQUGByNYATdltiAmZ4Dr37hQHgNox8yUkdrDffVmrgC4hVci2nMHDenUkH+28uTy7hKlhxhFTVNtqTpxJNjYxgl2u/JKo4FCINp0iuYmhmHzLEvt3vb2Lfgf/H7X4qlsQVmEEMgWSt+0Qp1sX+/cU83wRJHLXKiHUR7SLjaesXRMWuQ1IzExXBUlBs6HZCdMAfAl7Tc/Sh8PQ2FwLHQOdZPIbOEJNB+kdBvETKFD+cX6Q1xo8zUdQbczE989pc9/dh7TwxF5QI/7zPcoLxjPQMoV9VD8y2XMnCCUd9zXIme5PGH7111jdozDuuy14Ab6DPdG5MVvH05fshkCWCoguUXsLCR2HJCC7yFEqECOi7cDOInWLKPzmTvNOK69f8GEZNMYFGYX6kQIdn7ojfA7rBwTKPVkUpwkqLrgrMsXhWcicS1iXFRbS0ti4EHgb4OFtnlt3ktaQKnTkArPULoDkxeqyfYl1jWJQADHeBWpcWTnaaEXr+j1tUL8o6DWdNSaRM2+XJHCmfY8dEf1QqgKSILHlqz11cwdvWaFHrZlcAeprsqAlvBy1N+ahYXXvlqOGr0m0qvLcaE+0KHo+jTmahazsLjGETtk4VxrK/7JGIYOpsH5LIcs+mqx6CR2kzKi2W1XRGo6lk3ZBKxJ8h1BYigXTDzAtZ6gjgYUqCKXkh/Js5DzH6ETj9jHms50+xyWZBwZ6dB+tczIsIkMm64GWC+/W/EwsCC3UQeqAy4A3iz9T5XAC1qpeY7WvVWdyG/THFwaQhCVqNh0z/3YWxY4f8XoAY4ux0AJRqhevkfE4/WeFi57NWMVmwyrFlyXN9aw2q7YzclbbnLhCvxX0xc1Hi/3Yo5VvPjeVfqBSvLXqbv/p4q3qTQ/Y6Xx4Bn3NCfLz2YOHvvO4xs/PwG0DbFNOvqWpppRDhqub0PiPvlcwF94SmWBWgJe/fyjSiaNeYYJRAUknEtBGxip4BnCzC0MYp1Q0gO2xkpTfHs0MzAGKoQF6MsDGQO9FvsAHaIKwZ/YHeKRD6D6Sfs28QRc+h4jgu0XUQJoLUlyhZ9JgRB5wjjE4hOhFEkb5q7iQbOoyg9bNGHGclaR/hijaAr6lEiYxB5PcacbmuhKxDzBCwLG+m1uMCR6xH0V0VgqMhHuPBqOq2P9p2hDmDbnIk6xP4VyLfA81pLDu8PTNYpATFn6DqylzWzbT7LbOBaIYF/lgmGnBV0p3sKGDDq1muT0kQ8eq3thX66G0e1yS3/zPd6P+x7Pr8zYUm2nuLmIvstdi+eaafcVGgZZtZ2GBm2OLTc8vr3F7SfsLe/wNoiNexvnl8vWEX8BWbcNRf33lcDtD//eo3m6SCsHAtdf6GA362a4ra1Hx1Z3Bd4f4yZfI/BfGyZu58TwG7iJf/caF/APfujUZRIWVbx/2yj2IWGMo1sAuvvwjL9ANe/u/gf1l0qi
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Delete Role(s)' (delete-bulk-roles)"
|
|
---
|
|
|
|
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"}>Delete Role(s)</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/roles/bulk-delete"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API initiates a bulk deletion of one or more Roles.
|
|
|
|
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"roleIds"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Roles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Returns an object with the id of the task performing the delete operation.
|
|
|
|
</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={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`TASK_RESULT`]"} schema={{"type":"string","description":"Task result DTO type.","enum":["TASK_RESULT"],"example":"TASK_RESULT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result ID.","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result display name.","nullable":true,"example":null}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"TASK_RESULT\",\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"name\": null\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"type\": \"TASK_RESULT\",\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"name\": null\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><TabItem label={"400.1 Bad Request Content"} value={"400.1 Bad Request Content"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"1ea1adcb84da4dcb890145e05745774e\",\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}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1 Role ids limit violation"} value={"400.1 Role ids limit violation"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"roleIds count exceeded max limit of 50 for bulk-delete.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1.404 Referenced object not found"} value={"400.1.404 Referenced object not found"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1.404 Referenced object not found\",\n \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"Referenced roleIds [\\\"2c91808876438bb2017668b91919ecca\\\"] was not found.\"\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> |