---
id: get-lifecycle-state
sidebar_label: Retrieves Lifecycle State
hide_title: true
hide_table_of_contents: true
api: eJztXOtv2zgS/1cI3Ydti8iOH3nYX+7cJF1kkSa9PK7AJcEtLVE2W5n0ilJab5D//WaGlCzJynOL3W1hoNh1JGo47/kNRerW03OR8FRqdRh6Q28i0iMZiWARxOIs5anwNryUT4w3vPSKG4zuGO96wwuFCRI5x+fh6fOpNEyocK6lSlki0kSKG2EYZ7VnW1dqxFL9WSj2RaZTdnL68/9G++8Pj5lO2OjDIeNZOtWJTBcMKCbit0wmIoQnWMDjmKU4DwxrAXdGBBkOBA5vvQsjkj2tUvE1HQEF5FqGaihDoVIY488THclY+HHOjm+QnWEieOhd34FAc57wmUhFYoigRLHmHEhteApuwF8rxGTo1RVx6MawD3YMO9yHMbkc3jBNMgGsB1Mx497w1ksXcyRtQGFq4t1teOIrn81jvNYd7/Z2QzHww/Fg7PNxEPliu7/th/2ou9PnYb/b24UnGlmtidnEac0wf4BREfV2o0G/198Rg/7Wdne8NR7v9rt9vrXdG+yEwOQ1UjZzrQw4DxDrbm7i/+o+JMjgwqRg8aozsi/cMJMFgTAmyuJ4UfhYiK4QoOVVijT5fB7LgPy6/ckg4duSFOBDJxHZ18mjx59EkFYkv7RKRJdIMEZSaZkGHa7wfLYAZmf+RCiMJWA7UxIkAGUyHYG3CnaST1BVYFl/Mux0e/0tYoKHJypeWPXf5easz3oMV59Bn+N4NFkA9FPRIMYe3oCfLERdP51yd7Oz5W9u+d3d805/uLkz7Oz8FwZEOplxsIaH5PxUzkSTbDMdykg2sXPETcrs7eDP5gsYg/glKm+5EXt6NtNqP9UUaQ85TSqCqQJ+4+NG7xGKj2MrrKMy1joWXJUZt0FXVcbHqQCpExK9CGtGYc0o6RJdTJ+hNPS7hbausrMSwGVtnedDGY1dze2CFdQYeiQDRdZ5aTGqAfAPb0IVEImC4ZkRxE6F5EPMLNNS+ZH7k5dVROkuTZen6j2d2bTgJkS+JiIp+wJc6nXLLPS7daeoz36czcZgEfBHNw/YGOzDUzblN6LJUsQU5CAZH+u0cOuTuj4Kx2qorvAPlBmSehMxh3yKU6sJI7IMUmAkJ5mt6DSI15nw6j6pkJfFe674hMrec13zEAISL6PEisSeWVrILBGX6JlRo+8GU64mVjGWj1Ecj8KZVH+YEQsUBONEjfFEPJ+Zs7kI0E6IK76JZjIkxIwlC4xIxa6sR4zCEIxpjqRJrzw2FrH+ssLzA/zWaZSY5UnCF2VWMUuZ9F/4n1agZ5hD4Wd3eQHSloSCZhorfj0EIUkDayiY80FuuRCmxUABV02qBAk1UUAXqarI5Ep6svClXH1wT2zBEB4EmAVGAV4wDeqpS3xPFNq6Q6FlzbjA6HNkEaGOBYPgwsSCfIMflswdO20ZnSUAYn5ijqvWSlDyIE8Ky6R4cDx6e3TQUPKqHO7TX2NIRjJilg6gbIgG4KyhTqBnqGyGblFMsH94Rr+uQXGW18PwKTpbeolFQIf2vo2Nkv91g0Fnd3O3v729GfW3wu3NzvZ2ZyfkfNDtbG7t9oH0w0MAOa50H4UrWvBl+QYMZrAo5X8bNstMKUNbkVkEyCcDhwO9RDFkcALt9okWOxMC3LjtCIDvFi0OeYGdx1EwVYcclb2O7nBCr64v+P60atnPex/Uri15GK3cGB1IAsDU1TVXwDvsA3L91JpNuAlS9pv6gr1YQqVjB0kCOvfZqQBtK8ygNpW7loGNdUg9o1Q3PJbPawvqgV+NyFCkkFz2dNiIo6rMvpNK+JOES+RQEMsBPMiA4o0MMWHMdIJ4BUnm1YjGtSowCDTR6rC3PAR5rXx7Thj0sYQHn4HWYfg4QxfWevkjgFjId++ZVuwIPt7eHHT70Xaf8+5uv7OzNR5EvNfbHGwNBjj7DNwAinyT/1an/hm7IhmwWANwlL+DQgBWGYdOaPKHkm/VBkTjCfrHeLdjCzEdvwzXBjYgKb/d+8D6OyyGIpLRdT6pKUH5F2fYS0OjiYmy6Fgs4ZNETmQzinXZdP/g3eji6ByunB78++LgDH4hrZUIG0EVVCG6pSY0OYXKny4FoJ5XxKAOwPTsjaP6BgTiWHCWA6X9y1AzCr4V8SxO4Qk3e8MTZdIsSvSsEkqBXUhhr2RLtDagemA7xtNgysbc2NqGw99AjhPz1D9ymnzDpgCbRfK6xQCPSBQSOgCIxgyTL19gGQKIYMEPEogySr2YMnSWUs2HrFuxxVKVVWuUEknZKNT4fE0f9xPIyxkwR2KWo7DwFseisw9WcJqnyl1pycKqdKFSrLu4VrUANSYJIoYxyCZTw1w6QnMZSDwqH1dkrAqgQW7eW2ao/cT+nWfmCXH3IYb045NoxY0b4YKPkIrNRmSN3EwuI8HNdGpjJR9VmCsPfKiRIg7XsbuO3XXsPjF26zdP3Wqou0vQp7MKfS6UWw7H4rkCfRJh++x8zfx32/tbQ24gonUQ6ZeP527NHReMvs5xyeob4iNbyleYHxX2sNfHCD8KY1VsgQySHt3qBWQiEQ6J7yXHpCirqt7qbO90MpbgoKoBIlKLutAZYdUkUwo54WaDhVoY9ZNrCizAtRnQvs3wCeuvkeQaSa6r0boa/TjVaI0k17G7jt3vM3YfRJIFVxQtDieZbDbjycJ6mruP0nIGA1j+Xp4VIUemqqMVJMYKjOVVkYM37nbGnWgnEP2Q98Pt3iDqBttdvrXT2emM+90dr1zrL5dxXARZNaZK9rZ2JBUDiLsBHJcpcC6Tah1Wl/8y3HcSYVrD1FPgZtA5qPR6iR37De/TdQqyAWHAjsk9y4sXp0dIH99PIHnUm13+xaC1bwZoORQhJfowaBpfxqyh4xo6rsvPuvz8KOVnDR3XsbuO3e8zdp8FHfuPQcf+M6BjnyHEihBi/ZXQMQTcgdAsAqOADEEG6qXtym431XLvFKUfnkxEWgC9CorsDhr2r2rN3nO1yMGSqaxEqqW6ML3B2BmOTfKxEveLTCBFKtxEIrXdqiRnAjEp7nqJ5UxSHKNAQDdZ+KMoBalszOT+VswiVRBnwCElhVjj2qsGH5PgTiJC+AcUaB10Aon6G65xOmv9ofVgdooSH6HE7OBrIATGfLH+u9W0S+Aw33F4Zm19z3YBu2bOFbQR4uvcpq8Cgq6h+hqqr8v9utz/GOV+DdXXsbuO3e8zdp8B1R0auh+qw4AnQ3UY29pkBZZ6h871pyN2ChXHAbk30wFh9XCJwQlXgCu5o4uYQ/AA3NBr10/pmfZtw8G9u3btiBwMWz00d+fhMUPEk1aULIlhimmazs2w3b4FC4Nl71p8Llv5HEp/wZ307ZteQ76yxzjQ14CTMLM7tPHUo52kRXZJJLq+zZM0gbUSaQKdHKxF+xIepK/cEbEF9C7MktlgECbODekysDmHHuQnQ6Npg+7Giowg20US3z0mz396D8lhidwjR5P6HpwLxjPgsiae21+cnwo9Q7BuZ185G7osQPiaoLsy2QkO67K3gid48Ip2zrz65eP5a1Y66Gfo7I3EngKC7AO4CKXAUb6LBB+iqpTobGK3RI8q+3Qw5FgUg8DsSuFO88v88Ogx1IZTSOakUnxIUP7Ap65f5ZYJxY2IsWy2lppEx5OhaoOG2rzy3GsqkdRLSGXPPuFZqSvls32JmYsOMeAYJyK1huxynsvFS3K9lIl/5NR8t5mcqJnXNS6sai8Du+87gLhHEjw2pK0XT27p+SV62HjBFaRa5wE14fio7q4Kcqu9mI8KPR/pVfm4Uh+nEupv9TFm0x0zUD7jkB2yYKq1Ef9kdEgBw+BykkEUvZitLzipTxHhdzdLLPl2Sl/6gCaJvyMIDGWdiY+xmhOY0XZdhULyV7IsxPyv0GuH7NeKzHT5Eooujgx1YF7MM07o44S+zQHG8W9rGjoWxDbKQHnAOsDe0v6UCRyjpZxnaTVmdSLfpmewNATAKlEx86H9Y7hMcO4Xoxs4uhgDKRjBeLHfDA+sOVp0UKSsrHwZoa7BVX5jDfW0pjfLb/EyFGvs301elHi0XG3BU5ffOkvfk0n+Pnn3L8p460zzI2YaB4/R3Wha10eUndyitdW1PyPcQUy4S5FKOBy6nOWxrjKZecxT9GmK6WCKn2PAxXTBU0R+G+hXekZxCHA3oJOhltCEPkSQAMMc+jwZA70W+4iHFANQMbZkuFsXqH7Srjc7Ay1/oJN3+7nhGJ7NzxR+bAOYyGYMz18/Yt1QmiCzSQg6NCVyyTTBuOKpPCLRbVAVLWpOkpk5iXB5GTrXkhEfmQtsaNzaMiiSjl3bb3QsBTkVMbeHUzdq8Psx2uA5/lTEc2wKIYMCmBKlGd4fnq9QBGLKvdDQyaTtHjJtHAtEsNWxztBrQSuIl+bapNDBluieFt93qX1EpO5Rt8sl9b/kEzGugCDyb89xlYuOUtpOxPaLlytfdUEjrH43hj6gUm8ZcWTDl1agC5lqPIh96d3e4ioKNlB3ePm3TGCLfnm97I+oryxO5A4jSBb10+RlLb46dfK+Zs2fmmkUOV/+U4tl5+/Bz88CFwyahMVO8EVcNX5W5gVMNej1Dg8l22Un0podaBemSiRWXt1gW1gsFvx8gDHB70EY7gdYCHLo/wH/kHpU
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 'Retrieves Lifecycle State' (get-lifecycle-state)"
---

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"}>Retrieves Lifecycle State</h1>

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



This endpoint retrieves 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"},"example":"2b838de9-db9b-abcf-e646-d4f274ad4238"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"lifecycle-state-id","description":"Lifecycle State ID","required":true,"schema":{"type":"string"},"example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

The requested LifecycleState was successfully retrieved.

</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={{"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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\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}"} 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={"404"} value={"404"}><div>

Not Found - returned if the request URL refers to a resource or object that does not exist

</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"404 Not found\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server did not find a current representation for the target resource.\"\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>