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/get-account-activity.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

109 lines
56 KiB
Plaintext
Raw Blame History

---
id: get-account-activity
sidebar_label: Get an Account Activity
hide_title: true
hide_table_of_contents: true
api: eJztXOtz6zau/1c43g/b04kcyW/nyx3Xcbpu87q207PdNHNLS5TNHlny6pEcbyb/+wVA6mU5iZPNPtrxtHMiSyQIgATwA0jpsRasRchjGfhjp3ZSW4h4YNtB4sOfWN7LeFM7qsV8EdVObmv6CdOPpIhqd0c1R0R2KNdIAgjMljJiQCVinEXSX3iCcd2Na4psvmESGkinDsTXPOQrEYsQh3isSSSy5vESHvnwAH5JB64jeylWvHbyWIs3a7wbxSGQrz0d1ULx90SGAtiPw0RUGdrBAZEUX/lq7SEt4TZ7br/VbHVFv9XuNObt+bzXarR4u9Psd51e7ekOh4nWgR+B0MBEwzTxT3mogV8dKZj/JuwYRrMDPxZ+jL34eu1Jm5R+/FuEXR+r8mUd1yFOEWkbngLnFR1sizx2WOCyeIfgJakbdt/qmb1m22mIttXpmVbbaTbcXt+0udXuWahbNQWvDYg6xpb5sO8czg4Fj4VTVe3npfBLpNkDj5grwyhmaaejCpduEK44qLzmQAMjliBLiSPT6hpm17CsmdU7abVPmt262e/9DTlZBY505f6seBw4yTq9h5WeYXaMRnvWME8ajZNGr26Zrb+hFSSex+fYCpc3KinATm9QU95hT77KQ1b4tEzD6s+s5kmrjypr9tqkMj0McDKNeZzQcuWed+WSYW/TfH1FRUSFcRecA8uJo9MQfrJCjzS9GQ5H0yncORuMz28mI7gaXw6vLq7PRzP8cT26PB1ffl87wuHvipLkXWMZ053hNv9PR9tsP909pZy/LlE+Fhj8BJyUiOKdgmJHNB2ctGBr/sD0cYqEU2fs2hM8Ar0IQW3cwPOCBxiLeRIWH9oeEIqgITlhurniG7YIgwcW3IMScXrrv/i/+AYbekHiDJI4WKHt4J2xA+4JhhzEIMA8icXNGtcEPsr5x1/n0hX2xvYEqkkMl9xfUCsdHuhu3jcNJ1WqxMI1j6KHIHQK9LOmbLrx7WUY+PIf5CzZRLjghZfUGV2iq71okf1io4xTprjMn+F/t+eChz4YbSjYUoTi7ptlHK+jk+NjJ7CTFZAj4vWIS28dSD+uwyI8jjiPjpfCWx9H0N1e6j+4EAywfc+J6st45f1J3YbZMbQTNtI5NUAB/BPMQxq8QG4RpvxPk9WKh5tdkWB7wb0jMpwqFy0x+mp9RXrA4oJ1XfDUVs9qt13Rs0301Xjl9Bvtudm0OvuHhr8kK+4b4KEd5Jw5Mlp7sCbTaJFyURp9Cgq/RoWzqQjvpS3QFGtp0/Eb5BS5mPGSx0pyLTALxRoWAzyOSqPbVnved9u2zdu8Jfrtfl9wbopOy+X9hjV3atsuWLMyDwKwT7/Ki+/gMhWgcjBxz8OgLCL4FYsVhLAgLHO15PeCzQX4cUfYwD3Ecr/IH7mhp9xrba8bfMRDQGCHBXVYUB+0oEQYBmG0K+ZtAeAsElEPtgK2+EJER8SpvzlSSnsAZ8uET14RLikN0DLzMOQ4dyTLTrSf8X1bKzpm34clHYT1YXo1+moL4uuE/cbved2DAFAf44BhsgZFF57PICwGCfDFIamBcIoqTNE+i4NUDGYyNwxWzPYkaIi1u7zF5/2uwedN12hx4Rp9VzQMU3DXatvdptPoaPDSMSFoA48QG2qIIB4g7sBAb9Ko7vOv1uk0ADvSYx0B/QDWfJjeIOYzMs/gn3S46qK9l07CPQ1zohzaMMCokAbGmSvZkbZsM//PpEdAajsDbPXsdqvda1rzRqfVMvu8Z82Fa/P53BRNu80/zj/B4G8eOQUJO4XbieDLPJ3CE5hLhwAgsUB5QU5236wIgGAY3HNvF8CvwF+N0c/Gl+PpX0ancGsy+mE0nOnL2c3kki5Hf70eT+gqQ+u14eByODrHmxXgXqC3O2dQWJoBqvySqjv1bZ/hHk4/YdTn8D2KKCOgCXLkgj4nXs5zgbGby59Gk/HZePDdOWYhkJBcjJXcmKekCpj8XK2fXBcGL0izo7JQWUk5J6m411uSiBLihHxnpSsSbwMGtuqImPUtxYgscq74F5QO72lSuwoFrU7HdFttp2NanY7VdThGS7Pda+l4qVi4/AijfAt3A4ev2I8CooxDsXEeOJvXGRiq6k862C7Co5j9PQHaK8iIOPz7Va4g+72X9xz/+jCPDGJUEvoczNiHSI6rYSUwRRaeQHLJimEtr45soTP4EG+hWSWHseLOvhWUp1JeTcLS2ruX4uGQ7Byw6Ydh03RJHbzZwZv9m71ZtnWyHxAanGLcH05GAypNXlydjs9+hovTkS5Wno6nGjCMLvXFzeX51fBHuNB/JqOLq5/wwXQ0y7BRWeBJZukIGzIemfT3gxGKzVTcrd0gBE9XmdjPACieFvBeX0l5rQ/yrIeltJdVDmm7REQv1qUd8E82uKgJuCVyoABSkz3G/wmbEcLKeH5pmBkYXZSA4xr43NtAYnY7IP8GQMuVnjCsdqNvWqbVtxpW404FDpBCpH5rn7JxmcFL6p/bs1T1YVXiYRHwAGA+092uPZ+C/opRBxy1qA/BZYQB8hkFSWiL/V3glNrvNWvVLaBOU7g9UlWnZZrgBbtW07RNm1IMRUjXg8e+G7zdpWeJzRW131+qrGO+b1fhvq2472juLbtpWa2U+62R3+XPUz/+IjPbK3HH4DO9T/GsP6INkP+7nlydjcnZTK6085mNZ+ejC/i7a38XnGgShrAcPYRT63UQIot6bBJAsZvuRpSdy/aYqZ+Z5P0L3KPj3Zqn55MhhpWDKApsiVsa7EHGS90WEYhm8IjZfB0n4CEBcsSAvSIVxQAv6Rb1qvcrLkYM11QAuoDuWMl/waazeeOOI1EA7l2XFmqlErPlHcO5jEMESl/ExiCXxtZchlnxR5V9IH56CYIn7RzsIFTlKwdDf1n+ir8HAJREcbD6UWwsBIT0g6mxLGiYPW1sP23Q9IRiFdyLUx2g377Lh5GbuA4DXDphyu9auVScVD9gXuAvRIjTKxeAVdDvYJ9oDbARd1wzB1nfZ6+1Yeowb5on9H85xO+IefRcfBV2Ut7ffF0+bSx5Lp9RKW5kjv46Gt7MVPZOpYOf1fVsNLkYXw5U7SDd1zytlQoi+e1chNEWq7/zVftxC/b5acaH8LS162THUJV8R1TVNtgEcGqIy1AqAJzaFqJnXLDShwHV8ZYPOvahfNUwcPYIJ2fSF8Yi5BI5VIV4GzoyqmuRcmnLU5FMMTy1q5crk6ZZt9h33GHa/zGN+2mPKeQ2Zhb7xNYbX0J/lnYBW9WZ4M5hRVfwecfsN1pup8V5o9eyupik8mbTxASVTmfoInhh7N1l5++FL0Jpg/+wYUb+QYGKg+6JARp8/9oy0dhD/2j1qm0mZrqDEIuvEIE4+254zVpdhnsSCd3niy0l+MbNtIJzQHJF+CqUC+m/FNxPR2eDm/MZpQz/ezOaPpctDDAxoJwdWIW1sAweiGMtAOZJESRkiK3r7FtN9VsQiPtRsaFUvzQgdYTLEy+GHnr0HT2KpNXGStGUyG6+xuwbWRf1IzYXdJghBqQ55xHVCaj5t4i/17FxrjX5LVsCjBLhpzobZN5LmX9EhyHmAJCdgtdxEwQDBBZwC8gPYmmL8lzkqqw4TO1JzouTgsYBnO+R+9gxboeQmEUrzFaLZlHPD/CsNFfmblZQGql048cIi6AlADRyqoDFILOhM3faHeF0ReB4/LRd5rGKDpLc3YVi5jQO6JnNk2gPu7v2wP0YJFr24F5o44swfCtvRLORTpP2SDq2U2fdKpuu1PAZHbU42O7Bdg+2u6ftbj+c6B1u/ZSgj1WFPjc+T0C/IQXPCvQJU4CeNlK1JjWRRwjnNUT64fMMDPuL8LG9+LqWeo/6g/CRCuXVE7nZfKj787QWmob+fC6QQdKjksAFTyScE+I755gUpVTVrI52FgDyhQXq74CI4DVDtgkSxkFlYeLT/h4HSOwEIvL/HKtSuEa95AFxVN8x1AGHA5I8IMlDNDpEoz9MNDogyYPtHmz392m7LyLJjCuyFo2T0mMXtNL0c3VKCxrkZy0zk8t274poBYmxDGPVysihNm9Yc8vt2qLl8JbTafbdht1p8HbX6lrzVqNbK8b629yOMyMr21RhvtU8quNlIsT3KBIfFlcUB4FTLv8luIngoltD15PhZtA5qPQux46tKna8DGKQDQgDdgyfKS/eTM6RPgxN5FFvahcOjVbvueBGBkJKXMOgaRl94LtnB+h4gI6H8HMIPwfoeICOB9s92O6/Gjq2XoOOrTdAxxZDiOUixPpPQkcHcAdCMxcmBWRITwdkx3N19VGbvT7mlQK9Eops9KsochYE7AJ32DVYikqVSL/0VhPAV1jQ/iad/IhOCLIFuEgf382RgTrriscmAZPi6QVPriTZMQoEdMONMaAXnJTNpOstG0Vv8UfkFPAIB50X4xKWk3AR/gEFqoMuwFF/YI1Tz9Y/VQ9mE5T4HCVm+K6YQJvP6r/tXacE6O0ydBdTNdfPHBdQNXPuQxohvq6V+8og6AGqH6D6Idwfwv0fI9wfoPrBdg+2+/u03TdAdY2Gnofq0GBvqA5t6ybLsNQZLq5/O2InU9Ec0PJmgU1Y3ckxOOEKWEr6u2noQ/C7ZSe1460vvoBPOX6UzhO0UFmAYioJPWicfnPmEeYK5uipzteynp5m9oMH+ujMfXOH58GDpsrKwHc5ifp40OB6rFONOmk4lLiIlcejAZS+SSZcruknFF6kn76RsIEshCkyR3i8Xy8ouo1vCUI28eeIWtdpAVVkBNluQu/pNXl+ar4khyLyjBy71PfiWNCeAZdb4iH7dzhdMOn03g7M102EbxmSqxokONG3d8U2U4TmisNKyzzc4KZAo8LQFTZrsO8ED/EzTXRO5psfPs8+sQUCUnIICX5OjwmJGQSY1DUsI3J4g/TMCHaiGBQGyUK9CzQoncpBA2OuB0phv/hTIdht+l7SJUSCCbhuUjt2EuQtsFfhq0jiXngYJLe+iCQd/xi0eMxL/T5RQKTMQfrqRD6eecfPMp1K9FP0DQhso0WkRJDdrlO5eEGu9zLxp5SaoagZRC36tMWFUu2t/rCHDVaOJLgXkbbePbiiZxToYZoFd5DqNg+oCc1H+SyVnc7au/ko0TOQXpmPX/zP6h2uUjemnBuLIFh6DhszexkEkfgfxnDpoKncLhKwtHezRS+OGWQRRsMssGSoIQ1pAHYk/gpf6uJzjN0EXQJVRSGz/ZVmFvzCr/Sy568lmen2LYRYbOkEdvRunnFAAwc0lJ+INP/6XSJgFmwbZVCvFtMCGObzT55AM1rwi4rWTs9P5I+pD4YPG1glKtH6RP04yZ2gvmL0AFtnbcBNI/TOTpfhm9maFoaxkrLSosG2Bqv8egFEzy29KX6zrU+MqP9t8qLEg7y2cuV7m4/20s94kv8ev/sf8ngHT/NH9DQaDMv0Xd2tjzXgIleIrlrpi+jdP/gXnpKlEuoG3Kxe30QMUySz9niMa5ps2l5KQTWCteD04ugRriv1QUuExGj8kAkSoQV9IzYEhjlkddLDNwXZZ/3FrBATMDybC1R/C3Qmln+X4zSdOIbv/ic+vm8KTCQrxmF5vDK7jozsRDkh/ZEyxZD6rlbWK7VIXDaoCnoJVYSr6MrVnwUpTOIrY8EcRrqSDIqkF/3Uh5RzQSbCo1WG7coQ/TXasHIM/PolpoDgQQFMicIIF+NZhSIQ8/X2RRAujnWn6Bjb4ov6ILxaDM06JH54ax1EMeSrBbrfixgL5lsfoK6UkR7z8vnbP0StfT+C9uM1lqOQlUQlGiqxu61VEzvoeCIdfCFzCVxjm8dHrFpgmvOEtyFbx5T49i7PYiibAIXiNSSPLpjr9offipJ8M9EfuP5E+y67P2a9k/u05OZv8my7BpdfBCbp0I8+16CqKMSUeqDqLIUulZ0IzHuy3Pf7EUzk0/8DLaD6AQ==
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 'Get an Account Activity' (get-account-activity)"
---
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"}>Get an Account Activity</h1>
<MethodEndpoint method={"get"} path={"/account-activities/{id}"}></MethodEndpoint>
This gets a single account activity by its id.
## 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":"id","schema":{"type":"string"},"required":true,"description":"The account activity id","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
An account activity 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={{"type":"string","description":"Id of the account activity","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the activity","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"When the activity was first created","type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"When the activity was last modified","type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"When the activity was completed","type":"string","format":"date-time","nullable":true,"example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The status after completion.","enum":["SUCCESS","FAILURE","INCOMPLETE","PENDING",null],"example":"SUCCESS","title":"CompletionStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","example":"appRequest","description":"The type of action the activity performed. Please see the following list of types. This list may grow over time.\n\n- CloudAutomated\n- IdentityAttributeUpdate\n- appRequest\n- LifecycleStateChange\n- AccountStateUpdate\n- AccountAttributeUpdate\n- CloudPasswordRequest\n- Attribute Synchronization Refresh\n- Certification\n- Identity Refresh\n- Lifecycle Change Refresh\n\n\n[Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data).\n"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requesterIdentitySummary</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}></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"}>targetIdentitySummary</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"nullable":true,"description":"A list of error messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."]}}></SchemaItem><SchemaItem collapsible={false} name={"warnings"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"nullable":true,"description":"A list of warning messages, if any, that were encountered.","type":"array","items":{"type":"string"},"example":["Some warning, another warning"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>items</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Individual actions performed as part of this account activity
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Item id","example":"48c545831b264409a81befcabb0e3c5a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of item","example":"48c545831b264409a81befcabb0e3c5a"}}></SchemaItem><SchemaItem collapsible={false} name={"requested"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date and time item was requested","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"provisioningStatus"} required={false} schemaName={"ProvisioningState"} qualifierMessage={"**Possible values:** [`PENDING`, `FINISHED`, `UNVERIFIABLE`, `COMMITED`, `FAILED`, `RETRY`]"} schema={{"type":"string","enum":["PENDING","FINISHED","UNVERIFIABLE","COMMITED","FAILED","RETRY"],"description":"Provisioning state of an account activity item","example":"PENDING","title":"ProvisioningState"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requesterComment</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"commenterId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"}}></SchemaItem><SchemaItem collapsible={false} name={"commenterName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."}}></SchemaItem><SchemaItem collapsible={false} name={"date"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}></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"}>reviewerIdentitySummary</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of this identity summary","example":"ff80818155fe8c080155fe8d925b0316"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity","example":"SailPoint Services"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity that this summary represents","example":"c15b9f5cca5a4e9599eaa0e64fa921bd"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if all access items for this summary have been decided on","example":true}}></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"}>reviewerComment</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"commenterId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the identity making the comment","example":"2c918084660f45d6016617daa9210584"}}></SchemaItem><SchemaItem collapsible={false} name={"commenterName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat."}}></SchemaItem><SchemaItem collapsible={false} name={"date"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date and time comment was made","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","enum":["ADD","CREATE","MODIFY","DELETE","DISABLE","ENABLE","UNLOCK","LOCK","REMOVE","SET",null],"description":"Represents an operation in an account activity item","example":"ADD","title":"AccountActivityItemOperation","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute to which account activity applies","nullable":true,"example":"detectedRoles"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Value of attribute","nullable":true,"example":"Treasury Analyst [AccessProfile-1529010191212]"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"Native identity in the target system to which the account activity applies","example":"Sandie.Camero"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of Source to which account activity applies","example":"2c91808363ef85290164000587130c0c"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accountRequestInfo</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If an account activity item is associated with an access request, captures details of that request.
</div><SchemaItem collapsible={false} name={"requestedObjectId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of requested object","example":"2c91808563ef85690164001c31140c0c"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedObjectName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of requested object","example":"Treasury Analyst"}}></SchemaItem><SchemaItem collapsible={false} name={"requestedObjectType"} required={false} schemaName={"RequestableObjectType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The currently supported requestable object types. ","example":"ACCESS_PROFILE","title":"RequestableObjectType"}}></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"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs, if any were included in the corresponding access request item
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"removeDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"executionStatus"} required={false} schemaName={"ExecutionStatus"} qualifierMessage={"**Possible values:** [`EXECUTING`, `VERIFYING`, `TERMINATED`, `COMPLETED`]"} schema={{"type":"string","description":"The current state of execution.","enum":["EXECUTING","VERIFYING","TERMINATED","COMPLETED"],"example":"COMPLETED","title":"ExecutionStatus"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs, if any were included in the corresponding access request
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"2c9180835d2e5168015d32f890ca1581\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"completionStatus\": \"SUCCESS\",\n \"type\": \"appRequest\",\n \"requesterIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"targetIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"errors\": [\n \"sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.\"\n ],\n \"warnings\": [\n \"Some warning, another warning\"\n ],\n \"items\": [\n {\n \"id\": \"48c545831b264409a81befcabb0e3c5a\",\n \"name\": \"48c545831b264409a81befcabb0e3c5a\",\n \"requested\": \"2017-07-11T18:45:37.098Z\",\n \"approvalStatus\": \"FINISHED\",\n \"provisioningStatus\": \"PENDING\",\n \"requesterComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"reviewerIdentitySummary\": {\n \"id\": \"ff80818155fe8c080155fe8d925b0316\",\n \"name\": \"SailPoint Services\",\n \"identityId\": \"c15b9f5cca5a4e9599eaa0e64fa921bd\",\n \"completed\": true\n },\n \"reviewerComment\": {\n \"commenterId\": \"2c918084660f45d6016617daa9210584\",\n \"commenterName\": \"Adam Kennedy\",\n \"body\": \"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat.\",\n \"date\": \"2017-07-11T18:45:37.098Z\"\n },\n \"operation\": \"ADD\",\n \"attribute\": \"detectedRoles\",\n \"value\": \"Treasury Analyst [AccessProfile-1529010191212]\",\n \"nativeIdentity\": \"Sandie.Camero\",\n \"sourceId\": \"2c91808363ef85290164000587130c0c\",\n \"accountRequestInfo\": {\n \"requestedObjectId\": \"2c91808563ef85690164001c31140c0c\",\n \"requestedObjectName\": \"Treasury Analyst\",\n \"requestedObjectType\": \"ACCESS_PROFILE\"\n },\n \"clientMetadata\": {\n \"customKey1\": \"custom value 1\",\n \"customKey2\": \"custom value 2\"\n },\n \"removeDate\": \"2020-07-11T00:00:00Z\"\n }\n ],\n \"executionStatus\": \"COMPLETED\",\n \"clientMetadata\": {\n \"customKey1\": \"custom value 1\",\n \"customKey2\": \"custom value 2\"\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>
Reference in New Issue View Git Blame Copy Permalink