---
id: list-lifecycle-states
sidebar_label: Lifecycle State
hide_title: true
hide_table_of_contents: true
api: eJztW+lv2zgW/1cI7Ydpi8hXbn/ZdZO08CBNuzlQYJNgS0uUzVYmPaLU1hPkf9/3HilZV46mxXamMDDoOBL17uP3KOrG0wuR8FRqNQ69oRdLkx7LSATLIBZnKU+F8Ta8lE+NN7z0ijvM3bre8EJhgkQukAI8fz6ThgkVLrRUKUtEmiXKMM7i4kmDT3au1JUasVR/Eop9kemMvT19/d/R4ZvxCdMJG70bM56lM53IdMmAYiL+yGQiQniCBTyOWYp8YBkQAvkWPOFzkYoEpbzxJEqy4OkMbim4AX/JUKgUiPmLREcyFr4MvbrsY7eGvbNr2PgQ1uSsvWGaZGLDM8FMzLk3vPHS5QJJmzSRaurd3m60ci4090nzNsY1s34r32tcbBZaGfAI3B/0evi/Ko+aGMAg0CoFhXEpXyxiGVAUdD8aXH/T5KcnH0WQorUTjJlUWm6gT0MmFIiHb1W8zKUXX/l8EeOSQbDf3+vtbW6HA7Hd39nr9bfDzUG0t98LeH97r9+wTjV0mAw73m1u3W9hvLLyCT57pxOsgRgyIE6pCGYKrBOffDPLQvTzCo1m0ghWcCHGLIIsqOcMo+SC//AmpJdIFCzPjBWzQrIpZIsdDktP3B2S1hqlu8QtAKVT8SjXg7RzDmHmhRj+qSQDlOIBAsDvbfuDvfP+1rC3O+zv/udBcRx7hiRJnrkOZSR/nkA5/5VEQvFJXBFoonUsuCozswJVSb+fiXQmEihxoh4CjIor0cUyGUpDv4lfXuEOdGaT2nHFQJmKxCvpDZc2B/cFbn9QF+okm09AJh0xxweyHySEfJzxz6JNVmuEOZfxiU7BNra8vK0H6B1VReEzyzdc8SlV9W814jhidBklUyTe3NJCExJxdBao02blYMbV1Cpg5RjF8SicS/XdgtjWJRgnaown4tuFOVuIAO15YX6QZTIkxIwlC4JIxa6s50ZhCJ3FHAMouPLYRMT6S0Pme+St0ygJy5OEL8uiXkKdNem/8J9OoOcIOuDnYHUBupxMxdy0dMBmcpoURUPFGAkBBicphOkwMMBVmylBQ00UMESqJjK5kR6tPPYNmVI9ObojB2AJDwLM1lGAF0yLeeoa35EtPHi47B+djF4eHzUKmW0CE8hmGTFLBwAZhOlEtJUaJKmyOfqrIHg4PqNf16CR0VkSiHF4rzINMLC1s9OLtrbDnV5/Z6e/G3K+P+j3tve2GuKeEX02RkEaUVAKpkcQvn8JYKgGuM3jyjghDg32ZOH+NmyemVI9tPZhEXSqDMIGjBjFUC8JWdonOuxMCAjGriMAEVhAZ+zxjo+jYKphNSrHDt2BaIIQd+D1ARf8NNtZIXMYjja0bQQzixujA0mNnWaC9q5SskF1UoFbeHOrDf4exBLaFjtKErCrz05pMMFaZ4sugm0oNGyiQ5o3pPrMY0SaPwwmhyKFMnCgw1YIWRX2lVTCnyZcooSCRA7gQQYUP8sQngC4kSAmQ5J536B1nUrKgyU6ffaSh6Cv1e/AKYM2THjwCWiNWzFTVaALJeF5lj8CGIDi8w62YlfwyU5vf7AV7WxxPtjb6u9uT/YjvrnZ29/e3ye8BkEA7bgtRqusXwslEhmwWAM2ln+CQQC1gO1JAGL++DJJNB5hf8xpu7ZQ08kLMP1rugHz7MuDd2xrl8VQ7jO6zqc1Iyj/4gynwCyOsXLaZgyaW8JvEzmV7RXbldfDo1eji+NzuHJ69O+LozP4hbQaiTWCfqVCDEtN+GwGPTpdKfCFQ2sXMZgDcCJ74ai+AIW4MuWF0v5llgaMCbEV8SxO4QnHveWJMmkWJXpeSSXKm68peyY7orMB7QSuAfwMZmzCDTYVCz5eQB0Ti9Q/dpZ8wWaASkXyvMMAOUhUEoYcyMYMCyxfYl+CZm5hChKIMiqvWDB0llJ3hspa8cXKlFVvlApJ2Sk0831NH44TqL0ZCEdqlrOwiBYnovMPyGwtV5XuvGQ0MulSpdiIcZ9jCWZMErAwm4BuMjXMlSN0l4HCo/J1RcWqQA+U5o0V5jDVdC/gmXlE3r2Lofz4pFpx47NwyWdwH8ZWI/JG7iZXkeBmOrO5kq8q3JUnPvRBEYfr3F3n7jp3H5m79ZunbtPP3SXo029CnwvltlKxeTagTyLsRJzvt/5J8MY5cgNRq4NIv78/d/u1uAnxdYF7kz8QH9lW3hB+VPjDXp8g/CicVfEFCkh2tBpEUIlEOCS5VxKToaypNpvcXulkIiFAVQtEpGFyqTNCqkmmFErCzQYLtTDqNwf8Lby1FdDuhPuE59dIco0k191o3Y1+nW60RpLr3F3n7t8zd+9FkoVUlC0OJ5lsPufJ0kaau0/beQwWsPz1MytSjlxVRytIjBUYy6siB28y6E/60W4gtkK+Fe5s7keDYGfAt3f7u/3J1mDXK/f6y1UeF0lWzamSv60fycQA4j4DjssUBJdJtQ6r238ZnlmIsKxh6SlwM9gcTHpdYMfBfhM7nmvN3nC1zBGSqWBItbIR1jRYO8e1Sb4WFnA2hbqoGJQqqe3rIDkXQCXBNwuxnEtKXtQC6CZLfxSloIpNlDzICi5SBXEGElIliDWiZg2BJUFJESHmAwqEYKdQnX8gOnUu+i4kz05R42PUmB19DYTARC+Q+3bb/u44fx1+Zh18x0avnXa4ggCAgcDWrAJ3rvH5Gp+ve/y6x/8aPX6Nz9e5u87dv2fufgM+d2jobnwOCx6Nz2Ftp8cKLPUKg+v/DtMpVZwEFN5MB0GW0HZzjsEJV0AooUBTQTUED90OvW79oK/p3rSc/b3t1s7DwrLmQd1boGsHBqtKlsTAYpamCzPsdm/Aw+DZ2w5fyE7OQ+kveFqpOwGztlQse34Tow0X0Dlny6BDPkkkhr2tkUTceoisgAEOnqLd5Hsp0/lRcP1SZ1AVicwGgxRxIUiXQcQFzB+/mfyYK51erukHel0k8e3362IJ3aFLm/nu5QbrGUhaUxFVuEZ3QagAIfIXHus6sAVulGF4XF6X15whoLcSNlaumhQOgYOGQG9x2YC9FDzBo5r0XuTZ7+/Pn7MpwlgqI5lBBC0knebk7B2EEZXJUf6OAB+izpXobGqPu4wqb2EwLVkUg1HYlcKzQpf5GfUT6B+nUPDJ7PiQoBqDT10/yz0Yis8ixtbaWVkbg1OGqgtW7PLKc8+pjdK8IZU9K4qnfa+Uzw4lVjc8o0ZrnIo0PrLLRa4XL+n1VCH+kVPz3UEhomae16Swpr0M7KmeAGoDkuCxIWs9mbml55fo4XAGV5BqXQa0hJOj+u4syL32ZDkq9HykV5XjSr2fSejR1ceYLYnMQIuNQzZmwUxrI/7J6JgZpsrlNINMe7JYX5CpTxnhD3olkXzL0pc+IE6S7xgSQ9lg4hPs+AR4NGBBFdq0/UCehbrwAebxkH2o6EyXL6Ex48pQB+bJMiNDHxn6tk4YJ7/texhYkNuoA9UBGwAHK/9TJXCClmqjpdVa+Yl8l57B9hGAqETFLIb2j+GqCLpfjG7g6mINlGoE7MXbRDw47GjRUb+ysfKthroFm/LGGnpuzW5W3mKrC/vwX01f1Hi02pHBI+s/ukrfUUn+OnX3J1W8daX5FSuNg9AYbsTWzRrlIH/pMF1zh9AIdyQe7lKuElqHWWh1aLdMaBHzFKOasjqYSUF7CwvBU8SHGxhZek6ZCPA8oDP6ltCUvvFJQGQO06CMgR7tfuecOSWMBZ/oV/zbZDTg0GeC9ig+e4/n2ANwC456eH4D7n3UbuY7A8+8o/PWh7mzAXTN55nC7wBB7GzO8BuXByIilCbIbOGCyU+J3BaaoF/xVJ7FGGqoQoeGnmRu3ka4bQ0TccnxD/ACvxu3Zw2mp09m7PeGK0VORczthwUbNWj/EG2INn8m4gUOm1B1AYCJEoc34/MGRSCm3KF2nUy77iHTxbVABEcoGz6bnX6n59NIAdcX2qQwHpeI176FrIffzWqX/id9a+o6Do4K3QVunaEemR1v7BB62fjaFD0wbP8EtT6H4sqWT0ZhbJlp/ILm0ru5wa0ZnMxu8fIfmcC5//J6NXTR8FN8sTGMoLrUPwMq2/HZqdP4OWv/BLZV5XxPUS1X2wke/PwkcBeiTVkcMZ8kVev3sU8QqsWut/jRit3LIqvZhXa3q0Si8T4I58hiB+L1EQT57f8ALJdg7A==
sidebar_class_name: "get 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 'Lifecycle State' (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"}>Lifecycle State</h1>

<MethodEndpoint method={"get"} path={"/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}"}></MethodEndpoint>



This endpoint returns a lifecycle state.

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><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

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"}><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>