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

118 lines
38 KiB
Plaintext
Raw Blame History

---
id: update-lifecycle-states
sidebar_label: Update Lifecycle State
hide_title: true
hide_table_of_contents: true
api: eJztXFlz2zgS/itY7sMkWeu0Dssvu4rtzDrl2FnbqVSt7NqBSFDCDAVqCNKOxuX/vt0N8BJp+UhqjpQyqYxEAI2++wMI6M4JlyLisQzVsefsO8nS47E4kb5wV24gLmL4pp0dJ+Yz7exPnKyF2abrHccT2o3kEmkAhcu51Gz88ZgZUppJ5ckb6SU8YEE2WuNo5ksReJolWqoZi+eCTd5fnJ2yjzx259ev5nG81PutVhyGgW5KEfvNMJq15vEiaEW+Oxi1u6+RkPJ45DWv1JUaszj8RSh2K+M5Ozv/8X/jww/HpyyMiCGexPMwkvGKAYeR+DWRkfBgBHN5EMD0hm8gBPIuecQXIhYRSn3nSJRsyeM5NClogG/SEyoGYo1lFPoyEA3pOeu6OLZ92EfThx0fQp90amc/jhKx42h3Lhbc2b9z4tUSSes4AoU49/c7tTNnWmyQFusmXjPTc+e9Np2Fjt+G3gp7rI8tTzcGy+qYhX7FwsYJWOZkmnHXDSOPDB5+C5tfAgk/DILwFmlaj3K5YtN0dm//Sr1hQvFpIDz8WGAevyJHiYrHLjFonwitrdGOPXoGqpLBaRhLX7okypklAJp1QxWDpVFRfLkMbIfWzzpUjSUK9g/8iM0VnfMo4isgIWOx0IXn4fRn4cYVw44ZaouUxc5SpTKuQSZfKnDn6YpNzt8dMNQUa7Dn6rbkJhNIDhQL4H3gEuDoMGMsBfEJTRXPqeaCgunR3mAT+OqH0UKg0wqVLHAa7nk08SK8EfRhGXAXP9kHbrhEHUE2iZER8YUvlgHOm/a8t1w+ytGYmQarmFCC4SJIBstIaIxVm4diHs1EzJAmsg3eJAKxgA5WCO6Dm8dG3XFRSKfIXas4N7B4w4NEkO6UOPMpsaxzmw8+FbdFR0XxZRwUw3QnG45SzERUHL/bbucj0vbCkMy/0j7Zg4wEOHMMU02T2Fjcpp/lXAZyCVmiQC314pSY+X5fUxwEIy1YPSYadAjuUFbiTp6dse0K/ePKASt48NmaHL7nSWWj4oDPjK/3EIYUDVnsUHM2eGL8uuCBxq3Kpsws6XwyCaY4399Iyw9QWU8sOamJ03VHnb323nDY6075tNNvd4a9XnvI99r+bqfbRzKbu/R853rz3IU0V5gZ7Oxa+xydjt+eHEGbDpPIJQ5zznoD3vX3uv603Rnw3l7H7QALg7bbzzl7qItrOMvmOTy+2DDR3mDE2+5otAdURrzbHnb7e/3Orj8FKpskfCBFO4XIU9i6+sAVn1FtN9XMPB0HwdhbSNDNvs8DnT2/WAoXSX7SNMS20WRjz4PEoU+g+gH/11A5MSyANb0EHZuw6bbb+L9yIKSOs1bLm5uLSW0FyQK3nJ8BFdRkw0hw70wFq1TyPGys7nf7Xlf0OwPQfd/bBWOO2i7v9Pc6lVRaLvVMek3McSZJPGfiHKuc4tgHoYzREMMJaKZYuHMF2glOnz1lxvpliUZdtspmoYkpH61hnCYjyAt/sZEKioLukNqIzRLJTQk/E/SwlGoeAnZGG4VWms0FoWPxJNNjFebgZg56YiOWpICCP4ADNNr9RnfvstPbbw/3O8P/PsqOnZ555Mv3WMA9CJ0/jqF0/pwjiwMLDE0BDwleKt11IPfzXECVMqVqHeaC8S1dXGx4UtNnmi9dJxxg8i3MmtfsTG54tNvd5Lid7jpTp8liCjwB8rbzQPQDhxCPc34j6ng1SnggUz6aVdbz53OVeOwzeoycKWJvYWihCok4GgvEqdOyO+dqZgSoZOyvY8QsAAHXETXGI/F8ZtbKxNdrJkFCTBuywIhUAH/Wyw7goKmAxU+F5w38VktXBcjliIhQ97/wn6YbLiwK7+YPrqtrlwygVoLTLBJRMLOeAoUTF0I3GSjgqk6VhPRoAQEuUlaRTpX0ZOELWPDogRiALmtQ6RmrtXK0pHhnU9rPIFdZV6YITHH/xGeGDruV4KaAmmtSTWExlRFMQRZApiLMeliYChjoDQZtv9f3BgDEBp2hx/mo22n393oVdi+IPjtGRipeUHCmJxDe3AXAVGVVkfqVtkwcaqzJwn7XbJHoQj40+mE+VKoE3AaU6AeQL2l/xoxosgshwBlblgB4oFDeEheLVOPtPJaCLrvVuOg71FIB/Y/70++vO8NkupmFOjRlBCOLax26kgo77azVV5WCDsr7h7hUhMZeHQ4+CCSuqo+iCPTaYOcCNIrbGNIkXbsLxaahR7t2UgGSR6T5zWCyJ2JIAwehVwshy8y+k0o0ZhGnjRZBLLswkAHFG0lbWoswQkyGJNO6Qf2apZAHTTQ77C33QF4j34EVBnUYcfcXoHVci5nWVhFK/opraTsEMEC2mK6ZVgwFnw7aI1goDnqcd/d6nWF/OvL57m571B+NCK+BE0A5rvPR8tQ/CiUi6bIgBGwsfwOFAGoB3RMDNPnT0yTReIL+MaZN30xMyy/A9C/xDuPs7cFH1huyANJ9Qs/5bE0JqvHpAvdSkyDAzGmKMUhuCJ9FcibrM7ZNr4dH78afTi7hyfnRfz4dXcAnpFUJrLGinW9wy5Dw2RxqdJwLcMuhtIuAdpGa7I2l+gYE4koXO0rzTa80KBO3+XgSxDDCzl4zokia+VG4KIUSxc2XmL2STdHcgXICzxa0nzjluBsTGvDxBvKYWMaNE6vJN2wOqFREr5sMkINEIWGRQ+tqSLB8RbtinmdgChLwE0qvmDDCJKbq7IqyLXJVlq1RSCRFo9Ca70v8uJ9A7sW3DSRmMQozb7EsWvvgMpzmKXN3WVAaqXSlYizE+LZgBWqMItAwm4JsMtbMpiM0l4bEo9J+WcYqQQ/k5oNh5jAOqc3liX5C3H0MIP00SLSs4UbY4NO4rWayEVkjNZPNSHbDnQbbXpm50sA3O+jb2N3G7jZ2nxi7643ndvfPthL06dRsASr7QhKLZwX6RMKsiNO3lr+ZdyjGkDuIWi1Eev/50r71xE2IL0vcNv+G+MiU8grz48we5vk0fXOSlv7cFsgg6dFI4EMmEt4+8Z1zTIoyqtqtzvYujKYSHFTVQERaTK7ChJBqlCiFnHC9w7xQaPWDBf4G3poMSJs1XoPw/BZJbpHkthptq9H3U422SHIbu9vY/WvG7kYkmXFF0WJxkk4WCx6tjKfZdtrOY9CBpe+hWRZy2YvwIlpBYizDWE4ZOTjTbmfa8Yeu6Hm85w12R37XHXR5f9gZdqa97tAp1vpJHsdZkJVjqmBvY0dSMYC4G8BxiQLn0nEYeuXtP1BvJHxMa3QcJ8XNoHNQ6XWGHbujKna8DEP2gatVipB0CUOqXEeY06DvAvtGaV/owNkM8qLCg0syNK+D5EIAlQjfLARyISl4UQqgG60aYx/PFJlASZ0sm0UqN0iAQ8oEQWiOwd1yCUIKHzEfUCAEO4Ps/A3RqTXRVyF5do4Sn6DE7OiLKwQGeobc+3X7u8fp6/ALY+AHNnrNaocrcABYEJicleHOLT7f4vNtjd/W+O+jxm/x+TZ2t7H714zdZ+Bzi4YexufQ4cn4HPo22yzDUu/QuX53mE6hYjkg92ah6yYRbTenGJxwBbgSMkQXH5z8dO76hRnduqu5Q3PfWjsSC92qF17uga5ZMhhhkiiAKdILDndgY7DtfZMvZTOdQ4W3eF6pNQXF1uQsc4IT/Q070H0hM0GTrBJJdHyTJYm4sRHpAV0cbEX7yRsp0wlSMP4qTCAvEpkdBkFinZAeA4tLWIH8oNODrnTMfk0+kOtTFNx/vSyG0AOy1Klv42zQnwGnayKiCNdoLnAWIET2woNdBybFjRN0j8l1sc8FQnrDYaVnXqZwGditMHSG3brsreARHtakNyOv3n++fM1mCGQpkZgLZ0LSeU7OPoIbUaIcp28JcBDVrihMZubAy7j0HgYDk/kBKIVdKTwtNEnvep1CBTmHlE9qx0GCsgyOyq/geOJGBFhcm7m20Tmlp1qgxRYvjXtNhZRWHFKZ06J43vdKNdihxPxGF6uwjxWRFpBsskzl4gW5XsrE31NqDXtUiKjp12tcGNVOXHOux4XsgCR4oElbL57c0GsU6OHyDJ4g1XUeUBOWj/LbMze12ov5KNFrIL0yH1fq81xClS4PYyYpMg1FNvDYMXPnYajFPxkdNMNQmcwSiLQXs3WLkzYoIhrddoGlhpmyIRuAOYm/EwgMZZyJT7HmE+QJAQ0qz4TtT2RZyAs/0ZWbn0oy0+MJlGbs6YWufjHPOGEDJ2yYPKEt/6byoWNBbKMMlAeMAxzk9qdMYBkt5EZDqzbzE/kWjcHy4QKrREUv982X/TwJ2k+MGrB31gdSNUL27H0iHh22tOiwX1FZ6WbDugar/AYhVN01vRl+s80urMR/NnlR4nG+J4OH1r91ln4gk/x58u4flPG2meZ7zDQWROPe5nl+A/vopfcTK3ch8bQ+uDKJZFcyxQB6a/Fidf9RC3vgHlopD9BaAFZa+ZHgIiFgL8aIoYzhzqWgnYul4DFizx302nBBUQ7Q36UbAIbQjG4QRaAODmtNGQA92ltPZ+YUjAbYos/gd53Q8omu8puD/uwznpJ3weS4kMTTIdD2c2hXlBdgdbr6yw5TRwJAt1gkCu/qA9vJguENmke8zZPaTUxShHWlEqkuQoKV2ag0Q6AbowhNWlJFC33m46Y4rLcLTvXIXOBT2u6Ig+oLl3JzQc5FkF2KLS8bHqMNntyYi2CJS1nI6ADuRGGGD8eXFYpATNkj83iT3A7SLeyL951BeOM+u81Os92g5Qpe1Q51DIvvAnFzHZKt/WzBuhfe5a8CvpOfmbBFElc3rSXu96F6ErMiM5E9qfzQBBp2v/7XJ9aXztiz5tciIAnMQ7qx6tzd4X4SLibv8TFkHNysmFzn60RKOtk1k/T264N2eXVuJX7N6n/9olbkdCNUrQrJCz7+InDrpE5YXBW/iKvan8Z4AVM1esXLyY7ZgCOtmY72jU/jckXIKiW06YciUDgz2OzvbRhGKT3bc/k4vjz4N/Se2p/tWJj9o4jfwkP8d9+5gv/gi7lSRVWJnt856W4s9DGE8c//ARJFXWE=
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 'Update Lifecycle State' (update-lifecycle-states)"
---
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"}>Update Lifecycle State</h1>
<MethodEndpoint method={"patch"} path={"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}"}></MethodEndpoint>
This API updates individual lifecycle state fields using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
A token with ORG_ADMIN or API 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":"identity-profile-id","description":"Identity Profile ID","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"}}}></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><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
The following fields can be updated:
* enabled
* description
* accountActions
* accessProfileIds
* emailNotificationOption
</div></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>
Updated lifecycle-state.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"example":"2c9180835d2e5168015d32f890ca1581","description":"lifecycle stat id."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"example":"Lifecycle Name","description":"Lifecycle-state name."}}></SchemaItem><SchemaItem collapsible={false} name={"technicalName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"example":"lifecycleTechnicalName","description":"The technical name for lifecycle state. This is for internal use."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"LifecycleDescription","description":"Lifecycle state description."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state created date."}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","example":"2015-05-28T14:07:17Z","description":"Lifecycle state modified date."}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"Whether the lifecycle state is enabled or disabled."}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","readOnly":true,"example":12,"description":"Number of identities that have the lifecycle state."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>emailNotificationOption</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"notifyManagers"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"If true, then the manager is notified of the lifecycle state change."}}></SchemaItem><SchemaItem collapsible={false} name={"notifyAllAdmins"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"If true, then all the admins are notified of the lifecycle state change."}}></SchemaItem><SchemaItem collapsible={false} name={"notifySpecificUsers"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":true,"description":"If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change."}}></SchemaItem><SchemaItem collapsible={false} name={"emailAddressList"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","example":["test@test.com","test2@test.com"],"items":{"type":"string"},"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change."}}></SchemaItem></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"}>accountActions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"action"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENABLE`, `DISABLE`]"} schema={{"type":"string","example":"ENABLE","description":"Describes if action will be enabled or disabled","enum":["ENABLE","DISABLE"]}}></SchemaItem><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"example":"2c918084660f45d6016617daa9210584","description":"Source Id","type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"accessProfileIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of access-profile IDs that are associated with the lifecycle state."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Lifecycle Name\",\n \"technicalName\": \"lifecycleTechnicalName\",\n \"description\": \"LifecycleDescription\",\n \"created\": \"2015-05-28T14:07:17Z\",\n \"modified\": \"2015-05-28T14:07:17Z\",\n \"enabled\": true,\n \"identityCount\": 12,\n \"emailNotificationOption\": {\n \"notifyManagers\": true,\n \"notifyAllAdmins\": true,\n \"notifySpecificUsers\": true,\n \"emailAddressList\": [\n \"test@test.com\",\n \"test2@test.com\"\n ]\n },\n \"accountActions\": [\n {\n \"action\": \"ENABLE\",\n \"sourceIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n }\n ],\n \"accessProfileIds\": [\n \"2c918084660f45d6016617daa9210584\",\n \"2c918084660f45d6016617daa9210500\"\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink