mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
86 lines
36 KiB
Plaintext
86 lines
36 KiB
Plaintext
---
|
|
id: list-lifecycle-states
|
|
sidebar_label: Lists LifecycleStates
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXHtz2zYS/yoY9o8mGlO2ZPmlmZs7xXY67jixz4/LzTmZK0SCEhoKYAnSierxd7/dBUiRIuU4bqZXt5rppDIJLva9vwUB3nk6ESnPpFYnoTf0YmmyUxmJYB7E4jLjmTDehpfxifGGN155h7lbHza8UJgglQlSgOevptIwoUI/0VJlDMkZxuOYZVPBlggzbowOJPwM2SeZTdlJKFQms/l5qiMZC9N9r0Ys0x+FsvdH5ycbTKfs7OKH/46O3py8ZTzPpjqFRxhMm4pfcpkCsUyzwM4JV+GhLohgRJDjQBDjzrs2Ij3UKhOfsxFQQNFkqIbSze8nlgE/Lhj2DXI8TAUPvQ/3IHXCUz4TmUgNEZQoe8KB1Ian4Ab81SAmQ6+pLbEsNKNhhSjeMEtzAdwHUzHj3vDOy+YJUjdZKtXEu9/wxGc+S2K8JqLt/ehgsD3YEweDnd3+eGc83h/0B3xnd/tgL9yH0Y7TX3KRzhesxnImswZzb/hnpvLZWKRMR6Bck8dgS9BtKrI8VWCcSyHYzb+2UcXoECrkacgOdRyLAGmw81JJH15Msywxw83NUNyKGH2ua7iMyUu6gZ5tgv43eSI3jaPjByUdf6HslywC+890CnpS8HNGntutaSzisREVvfR3tloUCPOKiUjhSUvGXtruw4WZVHKWz7whPDfjn+1vohKKiIMW6K/7VdrUUWREU51ndBnYBg1iMEQ5eKjVKoMbXXZtcnDaOTOJCGQki6DokHU6qPiET6QCP4TnU51PpkTHGebZmOM3GKNU/2rlBzpXTd2fRKyDgdRhMgOtguITneSxVaVgnX/7VzrjsX+IT3dQpYlWRrApxDu4P9kBB7aEw5QDRZ3HIRsLFxlgORmVdgP9sY71iQ77JFBVEwUaC8FiYDOpAkGZS5gMIppxMDSwwkgQSGOKTfmtgMtgI1IOjpezhAfZBkpDeQ8sNoOkCxMrnaGnGIGzdojI30jyDvJE3N7yOBdWCzga2M5Nwc2z8KAVKXGsdSy48ip+Qk+u9BWjU0rgLXOtyrcVB0Wdc98IlAUqWD0VB1Ap4OLGTIcUyg2PvIS5SyfKDVoeHaxQFjNzlUH+tQ+N0aPU72yZ71A9wJfvuHxJDmKvodeZPElQgSFZkDIakNGf8DaIHIdmiB7oFMEKTXQ6HtbPIsQM6ri/tYX/q2voFKADRlodNDA9/hlYRaMFWMAh2OFJniSxDMh1Nn82+Phd04Q8TTlaX2ZiRtNCtj2LqHy7EZZ2zR9urLNgxU9RlZm0LEOVbnB8OTdA2p8IJcglWK4kuBw7OUI5UENnxQTLXrXwHBn2+tuDHWKCh2cqnluHvy/cdnnWt3D1K+hzHI/O6izTJHiIN9CnQtL3oyn3t3o7/taO39+/6g2GW3vD3t5/qgGD5PxMwuwtspWB0vQDDn5gbwe/N1/AGEAzovKKG3EIIa/VUaYJST3kNJkIpgr4jd+2eo9QfBxbYRvJaynN1ZXxbipAahtuJThlBE4ZAW+iixg5lIZ+d9HWdXZastpCW1fFUEZj2xBrSY2hR1L4L/HSZdQHwH94E6t7qmA41Blip0byIWYW/Ub1kWWeTpcUUblL0xVInKr741BHycKgv+wUy7O/LTGBmwdsbAstFe4WSxFTkJtk/FZnpVufLeujdKyWDksaKtqk3lQkkE1xasi8RBbAg4rkJLd9HQ3iy0x4yz6pkJf5G674hLqar3VNwFh0GSVWJPbM0kJmiThCWhe2y74bTLmaWMVYPkZxPAoB+/1mRorekxM1xgFofDUzlxaRB9g2fhPN5EioAvShuL+3HjEKQzCmweL33gNsBgW1wfMD/C7TaCl/JauYpUz2D/wHYQHmUPjZX1z4UKmVjbazvVijYM4HueUCungGCnjfpkqQUBMFdJG6ikyhpEcLX8nVxytiC4bwgDDxiNCOeQgdPByFtu5QaFkzzjH6HFlE4ACrHWJHvsEPK+aOnbaMztNAmO+Z46rbCEoeFElhkRSP345enR63lLw6h0cOOhoE/paOBf3AWUudQM9Q2GfdLCY4OrmkXx9AcZbXk/AxOlt4iUVAJ/a+jY2K//WDg97+1v5gd3crGuyEu1u93d3eXsj5Qb+3tbM/ANIPDwHc2FiBKl3Rgi/LN2Awg0Wp+NuwWW4qGdqKzCJAPjk4HOglgu6Q0YKMfaLLsDl67206AuC70GPZVS7yAjuPo2DqDjmqeh3dAYtDcLg1n+enVct+sbSF2rUlD6N1eVWvvQLeYxdQ6KeO8fEm6mjQ1hYcxhJKHTtOU1C6zy4qHbddDaFOmo11SGuCUkG7K8PuE/qFMvLrIRmKDLLLoQ5bgVSd2ddSCX+ScokcCmI5gAcZULyVIWYM6nwtyaIc0bhuDQeBJro99oqHIK+V79AJg06W8uAj0DoJv8zQtTVf8QhAlrJ7a5lW7Ak+3t066A+i3QHn/f1Bb29nfBDx7e2tg52DA5x9Bn4AVb7NgetT/4BtkQxYrAE5yl9BIYCrjIMnNPlD2bduA6LxCP1jwNuxpZiOX4ZrvxuQlV8dnrPBHouhiuR0nU+WlKD860tcNMjjGDNl2bJYwmepnMh2GOvS6dHx69H16RVcuTj+5/XxJfxCWo0QG0EZVCG6pSY4OYXSny0E+MQBMQjs0wHUs46j2gGBOFacxUBp/zLUjTK3FgJPuNlbnqiSZlGqZ7VQCuxCOXshu6K7AeUD+zGeBVM25sYWN1pEgyQnksw/dZrsuNWzl10GgESikNAC0OITZF8+xzoEGMGiH7sgSrkXc4bOMyr6kHZrtliosm6NSiapGoU6n8/Zl/0EEnMOzJGY1SgsvcWx6OyDJZzmqXN3VVEaqRTXcCDlB7SsG+g0RcgwBtlkZphLR7SUAolHFePKjFVDNMjNG8sM9Z/YwPPcPCLuzmNIPz6JVt64FS74CKrYbETWKMzkMpJbqqaH3ajSXEXg28WedeyuY3cdu4+M3eWbF24x1N0l6NNrQp9r5V53YvFsQJ9U2Ea7eCf6q23+rSHptamDSD++u3IvVXHF6HOCa1bfEB/ZUt5gflTaw61pF0veRelf2AIZJD265QvIRCIcEt8Lji1IJFVtN2d7rdOxBAdVLRCRetS5zgmsprlS9NrFbLBQC6O+d12BRbg2A1Zfaa+R5BpJrqvRuhr9earRGkmuY3cdu88zdh9EkiVXFC0OJ5l8NuPp3Hqau4/ScgYDFjtfypAjUy2jFSTGSozl1ZGDN+73xr1oLxCDkA/C3e2DqB/s9vnOXm+vNx7097xqrb9ZxHEZZPWYqtjb2pFUDCDuFnBcrsC5TKZ1WF/+y3F3RYRpDVNPiZtB56DSDyV27B80seOV1uwNV/MCIZkahlQLHWFOg7EzHJsWYyUu9U8gLypc/5favmWSMwFUcFcAo21BGLwoBdBN5/4oykAUt9nIOVk5i1RBnAOHlAlijahZg2NJ3LkTIeYDCoRgJ5CdvyE6dSb6TUieXaDEpygxO/4cCIGBXiL3nbb13ZPiZfGlNfCKhV7b7XAFDgANgc1ZJe5c4/M1Pl/X+HWN/3PU+DU+X8fuOnafZ+x+BT53aGg1PocBj8bnMLa7xUos9Zq2Q//eMJ1CxXFA7s10EOQpLTcXGJxwBbgSMjShUxN0imbobS6fnzGbdy1Hau43l87o4M5g2xtYrvM0BmrFlug7MCYY8b7LE9ktyCn9ifZF326v3GyHbgWThrndR4O7sO0kXTJBKtHLbUqkCaxB3C50r9x+/SB95TbyznUOSZDIbDCICOdxdBnYTKDd+N7QaNpGsdGQEWS7TuP7L8njdpOvkMMSWSFHm/oenAvGM+BySTy3C6Q4mnWJuNzO3jigtag12Mv1m/uxcFifvRI8xe2x9HrjxY/vrl6yynZs2mYvJO2g5ewcXISy3ahY6seHqAAtTteMai9TMLpYFIPAzB2WKE5vvYUycAF5m1SKDwlKFfjU4zfk89pzK45GvFc+O5KpcFvNcIwT0R4fuUkKuXhFrqcy8V1BzXdbfogaHgaocWFVexPYzTkBhDiS4LEhbT15ckvPr9DDHguuINVlHlATjo/6K7CgsNqT+ajR85FenY/36t1UQqmtP8ZsZmNmSueDTlgw1dqIvzPaSoZhcDPJIYqezNYnnNSniPD7WxWWfDulL30AjsTfKQSGss7Ex1i4CbdogHQqtCH5E1kWYv4nOrL0U01munwD9RVHhjr4ilMmSzzjhD5O6NscYBz/tnyhY0FsowyUB6wDHC7sT5nAMVrJeZZWa1Yn8pv0DJaGAFglKiYZ2j+GiwTnfjG6gaPLMZCCEXeXLwVxW7GjRdv5qsoqVgyWNdjkN9ZQOpf0ZvktV6ywnP7R5EWJR4uFFdwb/62z9IpM8sfJu/+njLfONH/GTOOQMLobTetahqqTW7TWXOYzwm2Xh7sUqQS5oaFZbL6tkklinqFPU0wHUylogSARPEPkt4F+pWcUhwB3A9q/bwlN6LhYCgxzaOlkDPS67B1uJQ9Axdh94ZYKoPqzdm3YJWj5nPZHHxWGY3iCKld4Xh+YyGcMT8l8wbqhNEFukxA0Y0oUkmmCceVTRUSi26AqutSHpDNzFuFKMjSpFSN+YS6wYXHAEBRJh2PsidGFIBci5vYIwcYS/P4SbfAcfyriBPs/yKAApkRlhjcnVw2KQEy5Teg6nWy6h8wmjgUi2OpYZ9juQteHlxJtMmhWK3RP6UMMzS87LB3FKlfO/7gfcnAVBluDzQRXvGhHvG1VbO940/j2Akra/LoDfWmh0T5CQzLVeHLmxru7w7UT7KXu8bI9PoxNZXloojgvvFKNz+sjCq26/ShwNaL4RoRbb/DoCOTj9fDX+vrBA3osvw7xREWuP2Xw/D5l8IA7FN+reKI3/JU/I/CgXhffdlho9sNiiesrs/iLC1eRXtJb+9ZP9rQyU7yvUfMqJwWTbRXpHg/b2WAlJu1Iu2pfodF4r43SlSupPxwjiuArejL3Y3iDa7D/A+hl87A=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Lists LifecycleStates' (list-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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Lists LifecycleStates</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/identity-profiles/{identity-profile-id}/lifecycle-states"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This end-point lists all the LifecycleStates associated with IdentityProfiles.
|
|
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":"identity-profile-id","description":"The IdentityProfile id","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"created,modified","description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of LifecycleState objects
|
|
|
|
</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={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></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={"technicalName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Technical Name","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":"Lifecycle description","description":"Lifecycle state description."}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","example":42,"readOnly":true,"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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
This is used for representing email configuration for a lifecycle state
|
|
|
|
</div><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"],"description":"List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change.","items":{"type":"string"}}}></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={{"example":"ENABLE","type":"string","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","uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features.","items":{"type":"string"}}}></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","uniqueItems":true,"example":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"],"description":"List of unique access-profile IDs that are associated with the lifecycle state.","items":{"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\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2015-05-28T14:07:17Z\",\n \"modified\": \"2015-05-28T14:07:17Z\",\n \"enabled\": true,\n \"technicalName\": \"Technical Name\",\n \"description\": \"Lifecycle description\",\n \"identityCount\": 42,\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 }\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> |