LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/create-lifecycle-state.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

94 lines
39 KiB
Plaintext
Raw Blame History

---
id: create-lifecycle-state
sidebar_label: Create Lifecycle State
hide_title: true
hide_table_of_contents: true
api: eJztXG1v2zgS/iuE7sO2RWTHjvPmL3duki6ySJNcXq7AJcUtLVE2dyXSJ0pJvUH++80MKVmSlaTtFnvbhdCgsCVqOO/zDEX6wdMLkfJManUcemMvSAXPxImMRLAMYnGZwTdvw8v4zHjjG6+8weiO8T5ueKEwQSoXSAIIXM2lYZPzY2YpGcaZEves8WDvVk1Ypn8Vit3LbM7OLn78z+Tw/fEp0yk9zfNsrlOZLRmQS8V/c5mKEJ5gAY9jlrlJesCaEUGOA4G9B+/aiPRAq0x8yiZAAVmWoRrLUKgMxviLVEcyFn5csOMbZGeccMVnwvv4CPIseMoTkYnUEEmJUi04ENvwFNyAb2vkZOg19XDsxrBzO4YdH8KYQhJvnKW5AOaDuUi4N37wsuUCSZsslWrmPW544hNPFjFeE9HWXrQ/2hrtiv3R9s5wuj2d7o2GI769s7W/G+55yDVSFiZ7q8Mlkqsz09B+CyMBKk1l+ChfLGIZkEv0fzH4/EOFT1D/WUSKcRzr6S8iyGokb6yiUJcpulcmwVPgWVDTGmuXS5OJxJ8JhW4INs6VBElAXUxHYGjBzooJ6iqqakiGg+HWaJuY4OGZipdWrsfCZM1ZT+HqF9DnOB6NYp26RYwDvAEfWQj3v4DycHOw7W9u+8O9q8FovLk7Huz+GwZEOk04WMNDcn4mE9EmW6JDGck2dk64yZi9HfzRfAFj4PhE5S034kAniVaHmQb9Pe80mQjmCviNT1u9Ryg+ja2wjspU61hwVWXcenNdGR/mAqROSfQy8BkFPmYXRxczTygNfe6hrevsrIVoVVtXxVBGY9dzomAlNYYeyUCRTV56jHIn/OFNCfGYKhieG0Hs1Eg+x8wq2KuPNHk6aSiicpemK3Lcgc5tWnATIl8zkVZ9AS5tDassjIZNp2jOfponU7AI+KObB2wM9uEZm/M70WYpYgpykIxPdVa69VlTH6VjtVQl+ANlhqTeVCxSYXBqNWNElkEKjOQst8WQBvEmE17TJxXysnxP1SM1X+6axxCQeBklViS2rUQpMkvEJXpm1Oq7wZyrmVWM5WMSx5Mwkep3M2JrrGCcqDGeii9n5nIhArQTluRvopkcCTFjyQIjUrFb6xGTMARjmhNpsluPTUWs79d4fobfJo0KszxN+bLKKmYpk/0D/+sFOsEcCh+HqwuQtiQUNNNa05shCEkaWEPBnA9yy4UwPQYKuG1TJUioiQK6SF1FplDSZwtfydVHT8QWDOFBgFlgEuAF06KepsRPRKGtOxRa1oxLjD5HFsHdVDAILkwsyDf4YcXcsdOW0XkaCPMDc1z11oKSB0VSWCXFo9PJ25OjlpJX5/CQvk0hGcmIWToAUCEagLOWOoGeofIE3aKc4PD4kj59BMVZXo/Dz9HZykssAjq2921sVPxvGOwP9jb3Rjs7m9FoO9zZHOzsDHZDzveHg83tvRGQfn7I5uY6ai9d0YIvyzdgMINFqfhuWJKbSoa2IrMIkE8ODgd6iWLI4IR27RM9dikEuHHfEQDfFSpcaKgY1gvsPI6CqTvkpOp1dAcsDsHhAPX3p1XLftE0oHZtycNo5cboQBIApoaovQI+ItIv9NNo0uDmI5Zds4BgsoEAIO4JpArT1B9nNmQxmLpWoGsFulagawW6VqBrBbpWoGsFulagawW6VuD7awVGwMc6OI0lVDp2lKagc59dCNC2wgxqU7l7i8CmOqQ3L1Ld8ViGX9QWNAO/HpGhyCC5HOiwFUfVmX0nlfBnKZfIoSCWA3iQAcU7GWLCSHSKeAVJFtWIxvVqMAg00RuwtzwEea18B04Y9LGUB78CrePwZYaurfWKRwCxkO8+Ma3YFXy6s7k/HEU7I86He6PB7vZ0P+JbW5v72/v7OHsCbgBFvs1/61P/iF2RDFisATjK30AhAKuMQyc0+XPJt24DovEZ+sd4t2NLMR2/DN+wbUBSfntwzka7LIYiktN1PmsoQfnXl/jqLI9jTJRlx2IJn6VyJttRrMumh0fvJtcnV3Dl4uif10eX8AlprUXYBKqgCtEtNaHJOVT+bCXAPQfAIGJQB2B69sZRfQMCcSw4q4HSfjPUjIJvRTyPM3jCzd7yRJU0i1Kd1EIpsK8j2SvZE70NqB7YjvEsmLMpN7a24fA3kOPEIvNPnCbfsDnAZpG+7jHAIxKFhA4AojHH5MuXWIYAIljwgwSinFIvpgydZ1TzIevWbLFSZd0alURSNQo1Pp+yl/0E8nIOzJGY1SgsvcWx6OyDFZzmqXN3VVEaqXSpMqy7+MZ3CWpMU0QMU5BNZoa5dITmMpB4VDGuzFg1QIPcvLfMUPuJ/TvPzWfE3XkM6ccn0cobd8IFHyEVm43IGoWZXEaCm9ncxkoxqjRXEfhQI0UcdrHbxW4Xu58Zu82bF27N090l6NOy8Hmt3KYSLJ5r0CcVts8udp78Znt/a8gNRLQOIv304crtXMEFo08LXLL6hvjIlvI15ielPez1KcKP0lg1WyCDpEe3egGZSIRj4nvFMSnKqmprfbZ3Op1KcFDVAhGpRV3qnLBqmiuFnHCzwUItjPrBNQUW4NoMSAtroU9Yv0OSHZLsqlFXjf461ahDkl3sdrH7fcbus0iy5IqixeEkkycJT5fW09x9lJYzGMCKt++sDDkyVROtIDFWYiyvjhy86XAwHUS7gRiFfBTubO1Hw2BnyLd3B7uD6Wi461Vr/c0qjssgq8dUxd7WjqRiAHF3gONyBc5lMq3D+vIfqDcVEaY1TD0lbgadg0o/lthxuL+OHa+0Zu+5WhYIydQwpFrpCHMajE1wbFqMlbjSP4O8qHD5X2r7kkkmAqjgpgAWy0RS8KIUQDdd+pMoA1FsoBROVs4iVRDnwCFlglgjatbgWBKEFBFiPqBACHYG2fkbolNnot+F5NkFSnyCErOjT4EQGOglct9uW989Lt4VX1oDP7HQa7sdrsABoCGwOavEnR0+7/B5V+O7Gv/XqPEdPu9it4vd7zN2vwCfOzT0ND6HAZ+Nz2Fsb5OVWOodOtcfDtMpVBwH5N5MB0Ge0nJzgcEJV4ArIUMLbSiJ4FHFsddvHlI0/YeWc4uP/cZRSOPhkUrEjpbtPI2B2jzLFmbc7z+ANcGKjz2+kL2CnNL3uN+pf7f15GY79CuYNMztPho84Wkn6ZENUolubnMiTWAtQlKjQ4NlaPX4WfrKbeRd6hyyIJHZYBASzuXoMrC5gH7jB0OjaRvFxpqMINt1Gj++JM+/tp6TwxJ5Qo429T07F4xnwGVDPLcLpDgBe4nA3M6+dg52VWywmRuu78fCYUP2VvAUt8fS+41XP324es0q27EN7ZCUtIOWs3NwEUp3k2KtHx+iCpTqfGY3rkxqb1MwvFgUg8DsVuF+oJvimOwp1IELSNykUnxIUK7Apz6+KiwTijsRY4nsrTSJjidD1QcN9XntuddUDqlvkMruUMUdrbfKZ4cSsxRtNcMxTkRqA9nNopCLV+T6Wib+VlDz3ZYfomZeN7iwqr0J7O6cAGIcSfDYkLa+enJLz6/QwyYLriDVJg+oCcdH/R1YUFjtq/mo0fORXp2PW/VhLqHW1h9jNrUxA6UyDtkxC+ZaG/F3RlvJMAxuZjlE0VezdY+T+hQR/nCzwpJvp/SlD8iR+DuBwFDWmfgUKzcBFw2YToU2JH8my0LM/wx9dch+rslMl2+gwOLIUAfmq3nGCX2c0Lc5wDj+bf1Cx4LYRhkoD1gHOFjZnzKBY7SS8yyt1qxO5Pv0DJaGAFglKmYxtl/GqwTnPjG6gaPLMZCCEXiXbwVxW7GjRdv5qsoqlgyaGlznN9ZQOxt6s/yWS1ZYT/9s8qLEk9XKCu6N/9ZZ+olM8ufJu/+njNdlmr9ipnFQGFcoL1a/g3FUNC0PxQ93cHcmpzw/5Pqq+vGel87wPHWq5pkjKc3DIXbetaMa1cuNQxNum/La+YSXTyG07Nq/We2MX+1Wr+xQ/0aboBGcrm/U/lbENzxML+RmrkesJjWLztfXdY1wxyPgLmVm6rFAG6vN1lUyi5hnmMMohwdzKWhFaCF4hh60gXlEJ5R3ob0J6LyGJTSj44EpOCiHHl7GQK/HPuDRATBFiu027qEBqr9o13dfgmnPaT/8YRGoDE/M5Qp/RgaYyBOGp6JeiOZQmiC3RQe6byUKyTTB9vKpIgNjmkBV9Mhz0sScRfjqQAaiErQvzAUxa9x7A1BkJd5WglyImFvn22i0Wy/Rhkzhz0W8wIYfKiaA52pEvz++WqMIxJQ7dKDTWd89ZPo4Fohga2udYasHbT5ewtY54apC156Sbf5sUdOdHlbvSv74Hz5yUAF7vP4C1y7paIPtOe0iwM3aLxWh+td/DYl+vmhtHQCCd65tinl4wFUwbIof8TJkWFxiufm46nkpp5RnYcYRFIDmOa6qsl5dOMles/YfSmoVrli+VcvVyo0HH38VuODTJtYjpgm7REcc2pHunZB/tSTUVlBae9mFawP2Cbvs9+zYj5WlmPMzXAD1pu7HmBK7qpTye7iI/4+9W/gHX+zxLapydP3BK9ZoYYylW8DjNnToPoAlYNj/AD/4VVY=
sidebar_class_name: "post 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 'Create Lifecycle State' (create-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"}>Create Lifecycle State</h1>
<MethodEndpoint method={"post"} path={"/identity-profiles/{identity-profile-id}/lifecycle-states"}></MethodEndpoint>
This API creates a new 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":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
Lifecycle State
</div></div><ul style={{"marginLeft":"1rem"}}><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={"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={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></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
Created LifecycleState object.
</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={"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>
Reference in New Issue View Git Blame Copy Permalink