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
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/list-account-activities.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

95 lines
55 KiB
Plaintext
Raw Blame History

---
id: list-account-activities
sidebar_label: List Account Activities
hide_title: true
hide_table_of_contents: true
api: eJztPGlz47aSfwWl9+ElKlMmddly1daWRpbzlPhaWc4k67g2EAnKzFCkQpC29ab837e7AV66LB87mcmqKhNTBNDoG91AE58r4UxEPPbCYOBUjiq+J+OubYdJAH9i796LPSEre5WYT2Tl6Kai21ih8Xav4ghpR94MoQCM0Z0n2UTEknFmh74vbGxgocu4Hs2z0Sy+4zGTgIB05/BDsIl3LwL2ZyKiOZvxiE9FLCJZAxzyX4DJ54qHc1E/aAugBX5GAl7IWDiGG0bwWtp3YsorR58r8XyGHWQcecGk8rSMs2CeI4LYi+cKJ8RF4zlnD1yyDDYD2DVWnYoq8wLHs3lMdAhmJ1EEIFgiBXQ4S+KE+/6ciUfbTySQxR68+I5VIzHhkQNoGOmMVSQP4XuRACm43Jfiae85Esfzt1GYE1Sk9a+kbHH0S+mTM2F7rgcUZZQ+eL7PxoIJQFBERExKd8RCeMEjUFVUTsWEkoK+kRkFXawyHjjFd+MXsYZofyEzsMsKo5u/YFrfm3pxZRH4GX9kQTIdIwNd4KZMfLD1OITHOImC2m/BlRDs5ucG614O2FUMlINcWS93BZeZJd9+dxfHM3m0v++Ie+GjM6pJ7vmz0Avimh1O9z0n2Oczb19qOEbuUozcI3yPRsmmYQRKHsDjlFzaClL3KuKRT2c+kFdvmStYCvOKiUDnocCoV406vJh6gTdNppUjGDflj+qZoDjC5cAF+vW0jpuh60qxzM4Leg1oAwdRvdwENFZxlUFDjV1LpWC5disFI+lUkfEzPvEC0E8YH4XJ5E6rOQnmmxHHG4SRsX8988kGlng/cFk1jhI08Vi5ilk4S3zFSsGqvxijMOa+0cPRVWTpLAykYHeCO6D+JAfsuMIc0MM+hInvoPdRloF+yc3kRg5B6USVPQhk1SQAjjkgMZCZF9iZqwIbh7U0RlSYMmabB+yOg6/hDGREzMH+3nQGZr6H1Hi4YoHEpiJwYOIgjFFTpMBZqwTkP4jyKuJE2N5zPxGKC9gb0AYPp7H5JjQI6VmhROMw9AUPKgU9UV5vna64nk9Rxgsc7gkNyaQP6wCIDDUjpZLJeRCD41TDxqgKwRdm6T8UXbjAajy/R9mepG9RZWQym4WRDnKUOwJQ4QM2g+vxHUl6q4LGMJJHCKFaRe5Uq0esKv4E5Qv2IPyDf6CIPvz14W8Afz0ZgGvbY/KhqkbZkQBLc2ggdY7VQByUAlo5cBo65AhfMrKyTtoS6d0o7YL3QYPihhTIVUB9WRGuANpXrgZI8KISXKl326kAMJ0kvse0BPdYLpHK0y3aqHKUEplZN038U+bTKSQaq1MCYLcdgt8Hdw2j+GzmY+wFo/b/kDj087KceBRxlKgXi6ksvA/HfwD5mDpEyC6CDq2es0rGCyvD8bqYEJyrFL5bKTieSt3uWIfmYaPl1EXLah+aVstp1N3Djmlzq3VooZ4odVue92VQNMc3KqkDPYzYm4oydNM6MMwDw7JG1uFRs3XUOKiZncP/Rqip+FaBRQvi49y/Pj/NoWG2jXprVDeP6vWj+mHNMps0DSgpdFqD/mvmsUzD6oysxlGzg+Q0DlvFeUCSYFJxQkJfBL9Z/CNlszCWcRc9ew4S1yARYORxU7m67vX6V1fw5qQ7OL0e9uFpcN67OLs87Y/wx2X//Hhw/kNlD6e/LeKfD4U8hd70FrF+SrF8nlk5XDCYoYoacHyW6wx0QnSVgAMD97fCSBZhvt5owItkCZjUExZxdF1Qc+vQarVccWibqOj45HTqrbHZsNqbzKU8478SCHzAk3EHMWeOJ2c+nzMcjKgUEskC58FpXqLTZFciuvdsQZxOuw5e5BwW9wzIfxLBsAjMwA1CsyzNblutccdt2TZv8abotDodwbkp2k2Xd+rW2FlnJ8UopoRLlptCHAd5AvorIeEX+kLtwgtYUdA4FiKAJcj2MDIMg8pCDPX0lCvlot5gE6XMO4XaKdQ7KZSIojCSK9bzRQVaXN/zaDyb7qZSjImCADQxjGq99Kn/aAsi9Ij9we95zefBpDaAaCOKkhnwp9A+ghUnTCCJ4x6FRkh5lgBCKjUFpvCJYCZzo3DKbN/DTaHWAW/ycefA4OOGazS5cI2OK+qGKbhrteyDhlNv6yWlbUI6Bjg6sla5BRoeeBTARO/ECBzytNxzW4hvCZ0AFOhxSUmbh3ar2TpsWON6u9k0O/zQGgvX5uOxKRp2i7+fgcLkL54525bbOqwq43SMGwaYF2EroVDeMd46DoPFOwohD8/DFjDAC5f2u5fiRh2DnAzOB1f/6h/Dq2H/x35vpB9H18Nzeuz/cjkY0lMWjVR63fNe/xRfLgUmBXirYyK1q8gewuhTyu7UuD/COxQ/4i8o4yrr2RPqOZLoSYAJdOSEriMvx7mA2PX5z/3h4GTQ/XCKURYEXGcDRTfGYSkDhr8uH05cFiYvUBOsCvMXNCnHJCX3coESUQq5erT5Er98ZVS7NhS0bWFtztLSMeWf0rxTg1qVZjTbbdNttpy2abXb1oHDcbkwW4dNvWAoFM7fwyhfgl3X4VP2kwB/7dDiMA6d+fMI9FTGmE62CnA/Zn8mAHvKwW8ztX8r2b13z/FvAHJk4O2TKOBgxgEsZagNkDJDo/AFgkumDLc9apT1o7Tfw1toVMlhTLmzbc72VMobiFjSvXtPPOyi/V1w9m7BWapSO2+282Zf2JtlpQnbBULdY1z3e8N+l7Zezi6OBye/wsNxX2/GHA+udMDQP9cP1+enF72f4EH/GfbPLn7Ghqv+KIuNygQPM0vHsCHDETdytwojFJopueViizkGTxcZ2WsCKB4D6eNktcjKyHbTrpixPNx59t0yhrTFSvuu63eVHPBPNrioIbglcqB0WPT8/D/TmRJGWBnOm6YZgdHJBBxXN+D+XMbspkv+DQIt1/OFYbXqHdMyrY5Vt+q3auEAKkTqt16+0XdO43N7BimiyemyAAk4QDCf8W7lfnDOv+KqA45a1HrgMqIQ8ZRhEtliexd4Rf23ktryBnK7IdxDYlW7aZrgBQ+shmmbNqUYCpDeIxwEbvhyl54lNhfUf3uq8pKTbKYl7FsK+7bG3rIbltVMsV+Y+VX+PPXjG5FZ1MQVk4/W7M1m/og2eP/ncnhxMiBnM7zQzmc0GJ32z+DvquKprMAEj/yzsxg9NxGg0KUCD1ljZeeyOGfqZ4b5+AL2T0vnV4P1yRAeDsFqE9oenkCow2/VFyMQjeAes/ksTsBDQsgRQ+wl1SqW1xvVlr1fURlxuaatlDMYDssO32DTmdy443hIAPcvS4r6zKltNxp7cYSB0icxN9T594x7kdyj8CqY63P5wPYTR53VqfU4UhtBDh3Ml+hf8vcQACUyDqc/ibmFASH90GftFp51pa31xdY6iScS0/BeHOsF+uWnGE5azBCFqDpRiu9MuVQUahAyPwwmIkLxehOsU9C1KMsFVbVtDprqpl7mTfOI/isv8SvWPGoXj8JOyqc2z9OXVmNluXwGpXhQ0/+l37seqeydtg5+Vc+j/vBscN5Vewfpuc1xpbQhkr/OSegvoLpSa59zql+P1hL+WEGi8Xs2D/l4J7J6uiVngcUpY8EUQIEFMC7WceRHaPl0u6xil1V80ayi+C5T+AWHBL2esGNzVeFCT+3z9/HMghlsWKjsKhSXMhQJ+lYvAAP1HPRFL61qWLMFr5bVXuhsoXMnXiCMScQ9xJCOWYCXjmC0BUt+gCqsFMhUMahfrbyJbpo1i33gDtNLNdPKROeBEbdRXbexxOvAg/EsHQIan1WZrJhWHAg+bpudetNtNzmvHzatA9xP4Y2GiXspVLqgjmFWnXGUp/5BBCLybFjqbJDIvymm4sB7QoAmr2x9DEIwtuA/LlCqb0ZmemwUi0cIljj70LtkzQOGB1EJveeTBSYExvXVkj8EyhXgi8ibeMGmOPS4f9K9Ph1Rdvtf1/2rdYltN0gLnUMqZbwLHwhjTQAanxQ+pYE1VtVQq0AQD2Sxo6d+6dxJ19zBCD37ihFF0Oo0rWhKZDePMfvOq4naHqwm8A78ByRFYy5pS0sVa2KqOIuNU83Jqq7S/L7GutlCq0Ir9CJzXKJgBc4XSDfBuJXiWjz3C8LYs0VZFjkrlwIx7VROi0JB4wDMt0jTbSwiJ50oWWGmLRrFtBDd0ZwrYzcqMI1YirVm4NNsKh+m9R/SBkjCsYSJaXdEJV/geIK0X+axir6S3N2ZQuY4DqnN5oncwu4ufXA/BpGWNdwLbXxUN668EUkjFZP2SDoMpcG6Vyau1PBVUdrOdne2u7PdLW13sXGoyxp0K4U+1nLocx3wBPgb0eK5FPpEaS6ZdlLbokqQe5h56hDpx48jMOxPIsD+4nGGxdzvGB+ppXwJ+W4mD117mwbY6dKfywIRJD4qClzwRMI5IrxzjFWQSKxqLM92EkKSBgoarAgR8bshNg8TxoFlURLQUTSH7M0JhQz+GevCfpWgkQfEWQPHUFUtu0hyF0nuVqPdavS3WY12keTOdne2+23a7sZIMsOKrEXHSWmFEGmablcFhdAhL7DNTC47aC5GKwiMZTFWpRw5VMZ1a2y5B7ZoOrzptBsdt26367x1YB1Y42b9oFJc629yO86MrGxTBXkrOapKSBHdQxyXBKBcMg5Dp7z9l+B5l4tuDV1PFjcDz4Glt1nsWO8sx46jMGRnuI2vIyRZiiGDUhEyTAxaHMzTiSWVIehLFMBVeaHa+sZdVIPhN2uMPj9F40UqAG40N7pUj6w/atVKls2izxEkeQI8J6JDae7F6b4+QKAIdgLe+R2jUy2iN0XybIgUnyLFDEu7BRp6Frm3Vu3vUjE4+ogrJeA1G70q2+EBKAAkBMpnZXHnLj7fxee7NX63xv891vhdfL6z3Z3tfpu2+4L4XEdD6+Nz6LB1fA59aybLYqkTunbjS4fpZCoaA1JvFtpULuTkMTjFFaBKiNCEbueZ8fgOfuzrshajdDOBivoVPknkQ7/0UobPICYQz1ONz7xaWsgRhA90M8MYeLPC7WB9gDIx7EB3QKgJasTYyEPdVY6OgCs26ztM8g8dN0JO60vmYQKujcDsYemg1iN6jZU5kET8U1LvGunNEn1A13XkP72dFgVoDS2r2LdxNujPANMFEpGEWxQXyJvqgkFe1xK/YiAv1U1Qxje3xT5XGJUrDJd65isNZnL1JYQusFudfRA8wqIoOtz47sePo+/ZBGNR8gXqMhB9Dxlnl6BG5Ou66UY/DqLlJ7/DqVs6SkHbYq4PTGH6Sp607vkcFoEheG1iOw4S5Chw1PbXhvDSuDUX8PwWGOzYi9StIuqLE02iuqToZpbSxQt0vRaJf6TQDAXNIGh4ZUkJC8XaG/0Jrg0GjiC4L4lbr55cwTMK8DDDgjcIdREH5ITGo3wAZqdSezUeJXgGwivj8VvwUdWIl4Yx5deYvKNbqAbMvgtDKf6TMVQdNJWbSQKW9mq0qDDdIIsw6mYBJUNNaXgGhI2E3ykYRqCUiY9x2aaoJYSALnCU2f5OkgW/8DuVff1eople38Dqij2d0H7BXTgLOOOEBk5oKD8hNf66VhmQxfo0oEEVGZIC9HL5kyfQiBZ8o4K10vMT+H0ag8uHDagSFDk7Uj+Ocieonxg1YO+sD7hqjLqzI0H88kvDwhWsxKx0v2CRg8v4+iEsnAt8U/hm+1W4mH5t9CLF3Xxb5SLw5+/tpdd4kq/H7/5FHm/naf6OnkbHwV76LdDCx6Co5B90TLe8zSfp6wL4P7SSrVLIDUFzfjtiEdDM5zFqNVm1fecJ2iCYCU6fpuyhZoVTskTI5dH8IQ0kQBO6+CoClDmkdJ5Pt7OO8pk5GYwKPlGu+Fsm+kuZEFQSEk5RYx8hZwsgsI8wX8MiDGj7I9SJW/6t8HEqbIaVw0mARdmAdjJlHFTqGY1wPGknynHpK0gUCSGFftmo1IpR1ZAE+jBGRFN54epPlQuCf2YukHt6cRqwnr4UUbfb5YQMhU+aif3Kof1zsEHbjDvhzzBjBK8LAZgozHA2GC1BBGCB+uKtFkaTfT1I7mNf/HgQiFfq06hZNdOglAJvhghlDDluAThdE7fi0ukFNfycb7n/n10/rdcWTAr2Z7jThRgnKpFROeNNZUXOCBnGHZCFrZ8/41YIJlFP+FrdQ4iZCTAatT+/0nIDcX/5PdUr+fBJ4I7B4vXbem+gQh+yvoXIL3ZV9VbE0cXbb6Dt27umeiNbVtza/QbmbLq2egMa1PTqib+tK603sCG9sfuVfPj/dRf1Bj5md3W/kpG7i6W/vYulN6hDenv4K7Vhdzv0V3879Ebx5xeCv1IBdrdCb+RvfgV3zt/b/NSAduohjCbfSAGzGqaOEgujloptEEp2vPNDH5KPp/8FlRTTcg==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Account Activities' (list-account-activities)"
---
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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>List Account Activities</h1>
<MethodEndpoint method={"get"} path={"/account-activities"}></MethodEndpoint>
This gets a collection of account activities that satisfy the given query parameters.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"requested-for","schema":{"type":"string"},"description":"The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"requested-by","schema":{"type":"string"},"description":"The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"regarding-identity","schema":{"type":"string"},"description":"The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"type","schema":{"type":"string"},"description":"The type of account activity.","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**type**: *eq, in, ge, gt, le, lt, ne, isnull, sw*\n\n**created**: *gt, lt, ge, le, eq, in, ne, isnull, sw*\n\n**modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw*"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **type, created, modified**"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of account activities
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the account activity itself","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"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={{"type":"string","nullable":true,"format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"CompletionStatus"} qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILURE`, `INCOMPLETE`, `PENDING`, `null`]"} 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={{"type":"string","nullable":true,"example":"appRequest"}}></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={{"type":"array","nullable":true,"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={{"type":"array","nullable":true,"items":{"type":"string"},"example":null}}></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"}}><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><SchemaItem collapsible={false} name={"cancelable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the account activity can be canceled before completion"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>cancelComment</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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"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\": null,\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 \"cancelable\": true,\n \"cancelComment\": {\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 }\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"}><Markdown> An example of a 403 response object</Markdown><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"}><Markdown> An example of a 500 response object</Markdown><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