mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
113 lines
33 KiB
Plaintext
113 lines
33 KiB
Plaintext
---
|
|
id: patch-workgroup
|
|
sidebar_label: Patch a Governance Group
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21v2zgS/iuE7kNfLnZsx3HifDm4SdpL0Ta9vKA4JMEtLdE2txKpJamm3iD//WaGlCzZbpp2i7vdwi0QyNJwOO/zkKLuIp0Lw53U6iSJDqKcu3j2QZuPU6OLPNqKHJ/a6OAqeqU/CaO4igV7hY9sdLMVJcLGRuY4GsZezKRlo/cnrMgT7oRlXDHxWVon1ZRNF+OJNRvP2clRm12ri5lgE52m+hbpJlKkCQ5NmB7/KmIH10YwkouPU3FwrRh7zhTPhL+qyeBv6FslzDX8GDGnPwrFbqWbkVzasNOzV/8ZHb09ecd44WbaSDdnILURvxXSiARGsJinKXNBlzaYIOcGZnPCoCHuIqm8nWbwCMWAXzKB65JHdOBMIbYiG89ExqODu8jNc6SyzoCG0f2y3U6OmJ7AjGDZJSMDV/GZZ3mKw3vxsLvf2d/Zi/lgMNxJOl242k86w73dTqfbH0b3N14IYd0Lncxx5lgrJ5TDS57nqYzJ09u/Wq1aZNK/4yU+XpGWG8PnIIB0IrO1+94r0bISI/b6/PTde+TJTsuQYtyCfyZSgWXB31dnLw/ZYNjpsRZRMyK/eTpzLrcH29tO69S2pXCTtjbT7ZnL0m0ziXHEs4aBryBqyTHgBFA6NxjETgqSEx6t2Hw1VAWrAh+dPoYQE2aiTSbQl0IVGU7DE+/ZDBxDF3nKY7wKN2Kdo40g2B0KsnBWSXkfpPyqRCPmHwTDaAmOMxCXuREWPIhPMEIcN1PhMB1mKDZmWCoyIAhK8MkEvOPN7epKNkJpuz43iPiJp4Ug2ylxOqEoX5Z2MfiduK0nHaovXdoI8Go4ajEVpj5+p9NZjCif14ZU8VXSVDcqFhDMDqYaF857PGRhPpOpzKP7+xq3MopLZv73/ZraJRhZIdixsGBDCIemEbcWhQKfXWN8XEdUrK5Ll8Pvit4+aDiQs5LrNaQhZUOVO/Q4DCYtzzx/dlQX/G5Jj5KodheLC18pLVjYgtuvfM7UotuHbDNMKvKVVsBUU7E22Pce/2HC2BzM4BXodTqrAo/WSvZA3VpbrKoYWSoF2Aq+XrtOkeyJZTLBTHPz9gojP/5rOVzyObo4ZUjZrlWSk6PjdxcnF/9ulonqLtgKmsijZyglxRa6pknw/mDCeSJEv9MdTMZ90enux73OYGeIE/l0eexUibQQFnPquM25zos818Y14phGHTn9WIVeLcOC9Qrt7w72493eMB6AQvsxdMDJsBN3d7o7VJV5cqrSuW+8j1ZwZepVDY9esFEcC2tXO/NyF//m2RoJ05i0mbprcQHMnolsLMyhLnyarBRc7GXc+VuDfn2G7qAPcGF/sAeluLNsvmW53xU4DQriJ4TYUyTTMqBro1CQtwoyDIb+AMG+JMhikgeEWQmLWpBW+JYClQpVf11tOkwldtZjY6DYt9iZcIVBKCO9VwLWYmMAWwgipYIKKZMfWL8S4bhMD3XyiHB+CSirNTWcwJYgkWMYyIDjJ5kgfsi0wcaALMvAIrpm+IEl2l32giegr9fvMCiDFjQ8/gi8Th6R2pdK/ob9NAyBmlU11DXTij3Bx4POsNefDPqc9/b73b3d8XDCd3Y6w93h0Ie8tXxar8hVf19KNgFVSMYs1QDm5e9gEAgGsD0JQJM/BGybPiAej7A/IghPW6kZ5GVOfHZb0INfHL5n/T2WcjUt6D6fLhlBtS7PcVlRpCkudqqK5hmfGjmVa2tN2WWOjl+OLt9cwJ2z439dHp/DFfJagTsjBdGaYFhqSqmZviWJgwK3gNstAEtEkm32PHB9DgpxyLkaofS/7NyCMRHq8yJ1MCLMvmZEnTWbGJ01Uony5rNjT2VbtLcAiMG9jNYUY46ITPt0f45VOXetN8GSz9kMkl2YZ202ShKJSvLU4zkL4+eEjJMEU9czmBSQyoJWhrpwTGkn4+XaX5my6Y1FGXlTdwomB0j+CKAfuwKEIzXrWVhFSxAx+Adk9pZrSndRMxqZdK4ch5qIi9c5mNEYsDADhMwkrKBDOUJ3WSg8qqSrKla9OlK5e+uF8QUS6hkv7CPy7n0K5adFqlUPPomQfBahta9G5I3STaEiwUNa4ODgQFW5q0x8vzuwyd1N7m5y95G5u/zwLKzI6tCnuwp9LlXYH8PmuQJ9DEWP0uUm2u9+H8U7cgv32QJEev3hImzCAb34nOPS+QfiI9/K16wpS3/4++Ny96Rs/QtfoIBkR6/BBCqRSA5I7oXEZChvqp3V2V5qM5YQoGoNRISqadhcF7SHaQqlUBJut1iihVVPHJtxqI/crzGoAuKsKmnluAG0QZIbJLnpRptu9PN0ow2S3OTuJnf/mrn7IJJsvqoIOMkWWcbN3EdaeO7fRgABK98NsCrlqtdQdbSCzFiFsaImcojGve64O9mLRT/h/WSwM5z04kGP7+5197rjfm8vqvf6q0UeV0nWzKmav70fycQA4j4BjisUBJd1WifN7T8wrxETLGv0Sq7EzWDz6k0IYsfecBU7XmjN3nI1LxGSbWBItbAR1jSgzZDWlLRAwNkU6qLCl5cS5MJQkpkALgaChqUyk5S8qAXwNfPWaILvFX2ilEFWzSJVnBYgIVWCVCNq1hBYEpQUE8R8wIEQ7BSq8w9Ep8FFfwjJszPU+A1qzI4/x0JgolfIfXfd/u4JvmPFGnHuHfyFjV6/2uEKAgAWBL5mVbhzg883+HzT4zc9/ufo8Rt8vsndTe7+NXP3G/B5QENfxudA8Gh8DrTtDquw1EsMrv85TKdUCRJQeDMdx4Wh7eYSg4MRrICb0s1pkkuL5ycolEcFHni6imSiDm7L0wEHt0Aqohs8LZYJiMHqgGy0OCJVUdvtO5ncRzgHgkmvR2FSICrPN96Be8Gt922ey3Z5hEfp23ass+0x2HRNucJzBT41kYCOsfoJ/AEuIzHmfYEk5t49ZAKMbnATbSU/yBkPvqDf57qAkkhstvAAU4g/ug0i5rD4eGLDMRl/ym5JP9Dr0qT3f1wXz+gLuqwz34OzAT0DSZdURBVuFiFxjkjdz74SGIvug6u73upZKSTrsReCG1hG+BceT19/uHjGpohPqT4UFqGxkLiggAx7DyFC9W9Ubv7jIGpJEE3TGQk+arxewXxjkxQUZtfqXAh2dRKM8A4awxlUcjIpDhJUPHDU4nRtIj6JFHtme2FJDDyI+W2w0DZvjHtG/ZEWElL5Izt4UulatdiRNOXxG6QJKtK6kF3lpV68ptf3CvG3klvLc2sRN/tsSQpv2qvYH9eJIemRBU8tWeu7J/f8WjV+uOqCO8h1WQa0RJCj+VIsLr323XI0+LWQX1OOa/VhJqH5NocxX7KYhd6ZJuyExTOtrfgHYxg6mAZX0wKy6LvFusVJW5QRrV6nJlLLT9mSLYCSJN8bSAzlg4mPsZUTktEA8lTiU/IX8izk/C90mvaXhs50+wo6LlImOrbfLTNO2MIJW74G2CC/b2gYWHhADXSgOuAD4HDhf6oEQdBa3fO81lZ1Yr9NY7A1xCAqcbH5gf9xsChw4YrRA6SuaKAMIxKvXhPiFwqBF3a1hrHKPYRlC67Km2popkt28/JWe1jYYP9s+qLGo8VWCx7x+9FV+guV5M9Td/9PFW9TaX7GShOwMW5Zni0+HzouVzHf+nnAymcOALIwlEmlsECpJ9CLgAVXtxVx33sm4C88pTpAEB8WUP6TLkRIdUYgnsOMoYoRz6SgDYlccIe4cgujVmeU5bnRWFpg2UmMpgZooCRYwLt8LFP8BAC3zMuZOSWjB60YM/jbFrQqog/GZrDAFW32AdaIKgaX4/oQD33As191WCieg9fpqx52VAYSALosKxQe4wexi4xxCNevRFsibVz4ohiOQXsVNMHKalRZITCMUYU2rZRMZk8nuNcNy+haUH1lLogpGza6wfS1720WipyJtPrepbkk+BpviOTWTKR0oh0qOoA7UZvh7cnFCkdgpizoFQv6SCwMsttIi58ygfI+fHba3XanRUsR/ApLWwdr6hpz/63a6pcxy3FY+4rup/3EMTROXPFs57i1hyYr/ArMZ/tVtFjpwoADmeCXLDOwKj67u8OdH1z73eNtKCK4rXB1s1jWUR0Br+M1rKMnUOOWvzWoG/rpWRD3GXvw88i1gpc7l2peK0tw+VHgXgdIfn8DVH4ziuTyD8Lbj9bFnOBIOfChDydxDewH+72uB4ZFjW2E96OLw38C9Th8qJn5vRTDb+Em/j2IruE//NC5zywgovt3UbkzCTSecYkB10GgcAG+ALL/ApxO5Fs=
|
|
sidebar_class_name: "patch 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 'Patch a Governance Group' (patch-workgroup)"
|
|
---
|
|
|
|
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"}>Patch a Governance Group</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/workgroups/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API updates an existing governance group by ID.
|
|
The following fields and objects are patchable:
|
|
* name
|
|
* description
|
|
* owner
|
|
|
|
A token with API or ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"ID of the Governance Group","example":"2c9180837ca6693d017ca8d097500149"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span></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={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value to be used for the operation, required for "add" and "replace" operations
|
|
|
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A Governance Group.
|
|
|
|
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Owner's identity.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Owner's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's identity ID.","example":"2c9180a46faadee4016fb4e018c20639"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Owner's display name.","example":"Support"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group ID.","example":"2c91808568c529c60168cca6f90c1313","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group name.","example":"DB Access Governance Group"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Governance group description.","example":"Description of the Governance Group"}}></SchemaItem><SchemaItem collapsible={false} name={"memberCount"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","example":1641498673000,"readOnly":true,"description":"Number of members in the governance group."}}></SchemaItem><SchemaItem collapsible={false} name={"connectionCount"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","example":1641498673000,"description":"Number of connections in the governance group.","readOnly":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180a46faadee4016fb4e018c20639\",\n \"name\": \"Support\"\n },\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"DB Access Governance Group\",\n \"description\": \"Description of the Governance Group\",\n \"memberCount\": 1641498673000,\n \"connectionCount\": 1641498673000\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |