mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
92 lines
30 KiB
Plaintext
92 lines
30 KiB
Plaintext
---
|
|
id: delete-workgroups-in-bulk
|
|
sidebar_label: Delete Governance Group(s)
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tz2zYW/isY7kMTjSjrall+2B3n1rqTbLyOPXlwPFOQBCU0FKAFSDuqx/99zzkAKVKU4yTN7rYdTWdSiwQOzvU7H0DyLtArYXgutTpNguMgEZnIxXttPs6NLlb2VD0rso9BN8j53AbHV8GP+kYYxVUs2I80IrjuwiwbG7lCKSDjg7pYSMtOzk6ZVDKXPBeWcRaBIEbyYRjTKdNKMG3YUhuQtS2290F9UH9n7DRlXK1xeL4QIC+RMchL2hPYgt+IhsxYKyViXA2Wt1bHkmbeynzBZN4FeQqEartjdRiUZSwSjCcJTJGKsU5HqksrOh2WSZuXChlhVyBf9FoyntinbMnNR5jObW12zBVTOkfhztnJ15sK3kURiRbuD/EJVLKo5lsz50r+RgH9Sgs7HRD1Shcq+WIbbcPC2nQS/nutrMyjyOKk7xrRTsdr9qC5Jy0xDXs300vZ/gpLjV6yuDBGqLwRkpoT3FL/LgSsDHblXKJRYOQmVSCRG15taXP6wjIyWubMfpRgpVbZGi/tdEEKAqsC5Crx+trSbHLBDs8tZLxwQVD6kRj0mLew06lAYAHeyuQSdFTFMhJm9ypYFzUX8pxqOZdLCMRD7qIyJwcM+v0dMsk/ui7Wp4ggxShs+cLoW/AGFFEsCMJ6nQ4Anl/smU7WwfEd/ZRGAEbmphDdAHWA6OItvlplmMQw9eBXixB4F9h4IZYc/8rXKwGgqKNfwWsgd2UQcXMpLN6VCf2vCaCvfTai+jt91bCph+jsFuHG8DX8lLlY2triNjdSzYP7biA+8eUqE4jkk8MpP5xNRXh0NInC8WzCQ57GkzCZTMQgHo74qD8EWfE06qfTaBgOxPQoHPcPR2E0nI1DPplMRqNRwuNkGFzfg+xc5ig5qLoHto4XpOS5c2ZDA2/8d1cEVSlrmJww7E/bPm7V0qY91SAg+IpAN+Wj7SBnCcvsCOB5bYFHYvdg4rTXPE1KDNtesbaOz4VaIILx4ZiLaZROZwMxnqVJNB0f9g/5UIz50exwNMGw2ZznxY6c2tX8Bfvp4uKs8iJzc6FsE3RtXhiFGAlgBFWHDeBGJgXP2vCWLwAFAER8KfpJFYIlBWrQYBbQ/Es646F22B8zxkLWll5Cgi3iWFibFlm29pPG/RlNas2R1GQLK7qAI3D1wWY+9su2JODoFPEcBtaDAHreb/lyO7w/FUtYzgie8CirvFobQ5juwZE8kyQSr4NvKYs/gTcVuHDJ3ehIF3lpPjablMusgKgxkcdb6gVo1Ne48FKRkoBUPjCtyelRP4r40SicHcXjcCziYXg0iI/C0XQU9/tidng4isCxMQd3Y4OrfO9XOBepMBiFNndgw2g6GEwBIUQymoTjIR+G/Kgfh0fpIBb9JB7zacpuud0OxxZe3ndruH+FNVcVwvUOvHNYdwoF3IRaV62Pl9mmygCzxq3S+jL3B/e7VKtDsavKwCHluN9vZ9rzTCJzeWkMZEUInvY1K5t9OILe6MJywzOZfBVafh7dEgE5nD0HwHgccV5JJcK5gZwHDQWpTEgDEgFYsA6IJjiRJUDSuF4TBfv93oA94wnz3Yo998ZgbzM8/giyTpPHFbpUEuazcgqTDrceWFZMBY8O+7PhOIX84MOj8WA6iWYpH436s8lshqsvIbp8LurwW7aLrRQRShgZs0zHEJHfwCEAF+B7UoAW//IOQzK+wP+I925sZabXlyHkdAGgnz0/Y+Mpy7iaF3Sdz7ecoMLLd3BFQQojbjiWBZY7wW+NnEu1SxUBlBJL88XLVyeXry/gyvnLf12+fAd/oazW3vRElVsOTTx0Adwv3xiAkGChTGJEctbxUjtgEFe2PlC6X3YNbWkJuZXyIgPy2/Gr75hRF+02CNuUFvH5ieyJXhdgD64BTAPvjriFCdqx1s5JjCQ1fO092WELaAfCPIXNygbsoRpBKMxfNzY8KCAtoJQFsXUEf4A/GYtmLDaubEZjgyqv60HB4gDNH8+TkzjHLk9m1quwyhav4mZL6DzX1O6i5jRy6RraHWxHYGSGG0TYc8WATGCbzC3zcIThsgA8qhxXIVadtxLcvXHKvMg13aPu83jdnWUAPyGZVt24Eb74iK87NBL1nuwRCW6i2TTZj6rCVRY+S6XIkn3t7mt3X7tfWLvbN0ve4+8S9Rm0qQ/w1gL8a6h5tqiPEe7sjZWDHJN2gewih/YU6ef3F1DYH/FoBuj0pxVSyO/Ij1wrbyl/UsXDXY+QflTBasQCFSQ/OguQ+ovkmPTeaEyOcq4atVd7pU0kIUHVDooIqGnYWheMg8tModx+xHbpUE/9UJ7pua0HISCuqpJwpaXK90xyzyT33Wjfjf463WjPJPe1u6/dP2ftfpZJVlpRtXieZIvlkpu1yzR/H63lDAZszsWrkqNQbbMVFMYqjhU0mUMQDQfRIJ3GYpzwcXI4mqXD+HDIJ9PBdBCNh9Og3uuvNnVcFVmzpmrxdnEkFwOJuwEeVyhILptrnTSP/8C9RqQIawg9FW/Gx4DB/XXFHYezNne80Jq9waedniHZBodUGx8hpsHYJY415VgYwNkccFExgCqp3XMPuRQgxUDSuMeNWLxoBcg16/AkzcEUVyhlklWrSBVnBWhISJBpZM0aEkviyX5KDxnNmhjsHND5O7JTH6LfxeTZOVr8mh6wvvwUC4GFXjH3ya7z3VNQ3iBGvHMBfuCg1+12uIIEgA2Bw6yKd+75+Z6f73v8vsf/NXr8np/va3dfu3/O2v0Kfu7Z0MP8HAZ8MT+Hsb0+q7jUK0yu/zlNp1LxGlB6Mx3Tm4fJhoPj6zsCLsp8TYtcAq9/7lL5BEi7e7VBHd+WLwsc38JQEVzjmwRLATmIlqy0JfThOCE4qAbbA3z9JnTvIuArDEQpnTWFyWDsIs9X9vjg4A6CDMG97/GV7AH2QZzztdK3vVgvDyLw7A7QkrYsYhxAb+25BXoUFiMx8x1MknAXJHIE5jgEiw6UPytZ8SVFf60LAEYS02VQJT4L6TKouIItyA+WRvco61r2gV2XJrv//bY4QQ/Ysst9n10NxjPQdMtENOF6kxjvkK+71VvpselBuMcbthZ7i8OG7JngBjYT7rHHk5/fXzxlc2SphBKFRYIsJG4roM7OIEUIBU/KRwA4iRoTJNV84d7RbDxkwapjaQYGsw/qnRDs6tQ74Z/QHs4Bz8mlOEkQhOCs6ydldBJxIzLsnL2NJzHxIPMPwEMHvDHvKXVJ2k7UXpnqfVAheyFN+f4rjvEmujfRrlalXbxm17cq8bdSWuikhSTNPt3Swrn2KnYv7cRQ+iiCZ5a89c2LO3lhTR7uveAKSt3WAT3h9Wg+GovLqH2zHg15Icpr6vFBvacXlJvTmAMuZqGDZgk7ZfFCayv+wRimDpbB1byAKvpmteit6JAqIhz2ayqFbslQhkAoSb/XUBjKJZN75474jAaqpxJXkr9QZKHmf6F3+H5p2EyXr6Dv4shEx/abdcYFQ1wwdBhgvf6urWFiQW2jDYQDLgGeb+JPSOAVreGek7UT1Un8Ac3B1hCDqiTFro7dj+MNwPm/GN3A0dUYgGHk49XDQvjNvCzsbQ1nlScJ2x5s65tpaKlbfnP6VidZ2Gb/aPaixSebA5e3Klt/b5R+AEn+OLj7f0K8PdL8FZHGM2Q8uDzffPPx8r/8mQJs8CG/yU6/d6lX1TNPENsnjlb4z3vgLoEDsX/YW7kvcJA21QWtMp5jGRGMxAsp6KxiJXiOZLOLqayXVPoroxFvhHWC5gbGAE5YIME8khnIo9P0cmVOFeqYLCYS/rYFbZhwrXgBe1/RY+9h+6hiyAPcOuL7IHDvV+33kO8gFc4wk9iLMruA5S2XhYLVEAiKJX4H9FgKJtLGhUNK/3GSM0ET16xmlbCBuY0m0DcRwizt2xSPwWGHXcu0R9aCRLP+DBxcj1HEbQHuzypDzkVGpYDjmvuEx2RDeocLka1w8wowL/Bl7c0Kb04vWhJBmLJgVyx62swP/CR7gGNBCO7HXPqMeoNeP6T9CVzHLR1stxvq73xX/4l9up2Jd5sHAPsPPvcffO4/+Nx/8Pkn/+DTs2c89jhY4Sk/QmThjmHcqddVsDn1ggn1c6/rbrDAAzIYc3eHh8F4EHSPl8ECPGm8ut6c8eAvkO0Ohemg7KPAw0j/FDK8WNOGwJ86th+v4tGTm+EOmj87tn6Gd/YWj9yDyH/TunTnmIbfwkX8F6Ac/oMfeuVaF374itfvgvKpAIxxcsud166Nh/8Dzby//w/vdH7l
|
|
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 'Delete Governance Group(s)' (delete-workgroups-in-bulk)"
|
|
---
|
|
|
|
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 Governance Group(s)</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workgroups/bulk-delete"}></MethodEndpoint>
|
|
|
|
|
|
|
|
|
|
This API initiates a bulk deletion of one or more Governance Groups.
|
|
|
|
> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted.
|
|
|
|
> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted.
|
|
|
|
> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization.
|
|
|
|
> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it.
|
|
|
|
> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.**
|
|
|
|
## 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={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Governance Groups to be deleted.","type":"array","items":{"type":"string"},"example":["567a697e-885b-495a-afc5-d55e1c23a302","c7b0f7b2-1e78-4063-b294-a555333dacd2"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"207"} value={"207"}><div>
|
|
|
|
Governance Group bulk delete response.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Id of the Governance Group.","type":"string","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"\nThe HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation.\n\n> 204 - Governance Group deleted successfully.\n\n> 409 - Governance Group is in use,hence can not be deleted.\n\n> 404 - Governance Group not found.\n","example":204}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Human readable status description and containing additional context information about success or failures etc.\n","example":"\n> Governance Group deleted successfully.\n\n> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use.\n\n> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found.\n","type":"string"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"status\": \"204\",\n \"description\": \"Governance Group deleted successfully.\"\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"}><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> |