mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
97 lines
54 KiB
Plaintext
97 lines
54 KiB
Plaintext
---
|
|
id: list-account-activities
|
|
sidebar_label: List Account Activities
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXHlz47aS/yoo5Y+XqEyZ1GXLVVtbiiznKfG1kpxJnuPaQCQoMUORCkHaozfl777dDfDSYcseJy/OqnKYIq7uRqP7h0YTnyvhQkQ89sJg4FROKr4n465th0kAf2Lv3os9ISsHlZhPZeXktqLLWKHw7qDiCGlH3gJ7gT7GM0+yqYgl48wOfV/YWMBCl3HdmmetWTzjMZNAgHSX8EOwqXcvAvZ7IqIlW/CIz0UsIlkDGvJfQMnniodjUT0oC6AEfkYCXshYOIYbRvBa2jMx55WTz5V4ucAKMo68YFp5XKdZMM8RQezFS0UT0qLpXLIHLlnWN4O+a6w6F1XmBY5n85j4EMxOogi6YIkUUOEiiRPu+0smPtl+IoEt9uDFM1aNxJRHDpBhpCNWkT3s34sEzILLfSkOKuITny98pLpud6xj87jVPrZb9Y7dNi14snnb7Zi21bAawM9z8pgsv0wcOfdFwbwbMawO9VJhyIWwPdcD9jOxPHi+zyaCCeBGRMR5KqSIhfCCR7AIUO2VxEqq/4WSK2h5lfHAKb6b/HFy9L25F1dW5XPBP7EgmU+QbRdkIBMf1n4cwmOcREHtl2AkBLv9scG61wM2ioFemA3Wy03Ddbay776exfFCnhweOuJe+GicapJ7/iL0grhmh/NDzwkO+cI7lLofIzcxRm4hvsFFyuZhBHocwOOcTNzTcqm3zA1aAeOKqUBjorpRrxp1eDH3Am+ezCsn0G7OP6ln6sURLgcp0K/HbdIMXVeKdXFe0WsgGySISuEmoGdKqgwKauxGKrXIdVKpBc1OFQW/4FMvAK2C9lGYTGdaOWli3s10fMFkZOLfLnxajWuyH7isGkcJLsxYLfBFuEh8JUrBqj8Z4zDmvtHD1lUU6SIMpGAzwR1Qf5oHrLhhOaARfQgT30GboVYGWhM3mzdaxkonquxBoKimAUjMgRmDOfMCOzMwYKbAt8ZIClNmxeYBm3GwEJzBHJFwsL43X4DBOUBuPPRgMGNzETgwcBDGqClS4KhV6uS/iPMq0kTU3nM/EUoKWBvIBrukqXkXGoT8bFCiSRj6ggeVgp5Qy6264no+oY4X+IwzapLNPlhvmDLUjJRLJpdBDIZTNZugKgR/ski/UnyhW9R0foNze5a+RZWRyWIRRhr0KHMEXYUPWAymx3ck6a0CkWEkT7CHahWlU62esKr4HZQvOAA4CP+BIvrw14e/Afz1ZACm7YDJh6pqZUcCVppDDalyrBpio7SjjQ3noUOG8CUtK0WPiPRCRfZLZZC696FwQSqzXyrrKrZNTyRK6kk9KdgtXIrckALnA5heV6ER9PYXVyBkeFV9RurdbsoD00W6csD03B+wfC5LM6TLN0zGHb5SdliixOumiX/KwjyHfc3mHQj0aIfgVsAbQCu+WPgIyKDV4W8Sm35en0weRRyn3YvFXBbeh5PfQEa4U4lQptQ7lHrOJkVYcTzONqBY2YDcGi2nLlqA2kyr5TTq7jEAN261ji3UIqWMzw2IoBZr5sO+crh0YtZE/mEG+7i1XZTrRTAT+WxuXR8OVDBiD3gpUWRaR4Z5ZFjW2Do+abZOGkc1s3P8L6Qk1ZxdSfE5UJI1eg0px4bZNuqtcd08qddP6sc1y2z+C+0BGBk+SV0QCinERi8QU95gR7rKQ67RaZmG1RlbjZNmB0XWOG6RyPQwQAlYjDghdQVseeXSDnu1z+c1SlIvjLvo/PLO0U2LAMHZbWV00+v1RyN4c9YdnN8M+/A0uOxdXVyf98f447p/eTq4/K5ygMPfFTnJm4KFpje9VfrRNK9I/+4xpfx5jvKxwBAMFdjayCg5DLInZFtL86cBGEAlxq4BaQA+lEKs2D9fGyTsSEJFCprQyzlfsmkUPrDwHreVML0EuQzW88PE6SZxOMe1g29SZ9WNgYFJEoubBeoEFuX0469zzxX20vYFikn0ZjyYUi0dzqG3eds0ALTeK5FwzaV8CCOn0H9WlY2WgQ2bjsD7NxnRzI1iYzSJrrauRfKLlTJKmaIyL8N/bs8FjwIFA2HTLQqeLLQTgLaxgoVlbyY5l4cz4S8OJTS3Z/oPKoKh/FBtFs/9r9RrdGjaCBvpnBogAP4NzAMummyXn9I/SsCVAxDY4AlWFe4VnuFUmWhQjyz0IPWARYV1XbDU1rHVarni2DbRVuOT06m3JmbDau/uGv6ZwOYBfDp3kHLmeHLhg06m3qIQQiksTRD4NQqcjUR079kCl2IlrTp4AZ/rcThCEsQwwKEFKAMUyzI4sFqTjtuybd7iTdFpdTqCc1O0my7v1K2JU1k1wRt2AiVasqgM7IXAHqJTFhJ+ocPXYKZAFW28JgLsuAM7ctxdhUFlZR/y+JhbrVW9wSIKFu0Vaq9Qb6RQIorCSG7yeWXKupknohZsDmTxqZAHRGmwPNCRC4xHiICsosCYRI5LtqHhfGuc0X1bKRrmIACVDqNaL33qf7IF0XXCfuP3vOaDA6gNcMAoWYCgC+VjcIthAnRxj3YbKMIsGhOHKRvMZG4UzpntexhXbR3xJp90jgw+abhGkwvX6LiibpiCu1bLPmo49bYGL20TnDbQCL6hggjiAfwODPQiieo2f7RMRyGsIz3WAfQfUjxavyDis2624J90uHWlvfechPsa5sgc2jDAqLARjDNTsmHb8pbbI+gKlnFpjTaP7VazddywJvV2s2l2+LE1Ea7NJxNTNOwWfzv7BIO/eOQsHv9kEKCI4Ms0nWLMEUMrWEoklA+hdt4VARCMwnvubwL4a/BXY/SzweVg9M/+Kbwa9r/v98b6cXwzvKTH/k/XgyE9ZWi90ute9vrn+HINuBf627xnUFiaAar8mIo7tW0f4B1OP2HUbfgeWfQk9Al85IxuYy+nuUDYzeWP/eHgbND99hx3IbAhuRgovnGfkgpg+PP6eed1YfACN8HamljXpJySlN3rFU5ECXH2KH4bvxwYqMAvYdaXBCMyzznnH9MAlO5qU6Cg2W6bbrPl4IlS2zpyOHpLs3Xc1P5SkXD5FovyJdR1HT5nPwjwMg75xknoLJ8noKeiQulgmzrux+z3BPqew46IM3UEJNm9d8/xbwDzyMBHJVHAYRkH4MlRG+YCt8jCF9hdMmcYOa1R+A9n+y2shSaVDMacO7tGUB5L+2pilnTv3hMP+83OHpu+GTZNVWpvzfbW7E+2Zlm2025AqHuKfr837HcpNHlxdTo4+xkeTvs6WHk6GGnA0L/UDzeX51e9H+BB/xn2L65+xIJRf5xhozLDw2ylI2zIaMQTnZ1ghCIzZbecv7VE8HSVsb0FQPE0gPe8JuWxPthnPcw8e7ZOIR2j0NnK9ri0A/bJBhM1BLNEBpTOm58f/0c6lkaEldH81DBjWHQyAcPVDbi/hI3ZbZfsGwAt1/OFYbXqHdMyrY5Vt+p3ynEAFyK1W7uEjcsEXlL7fD17Kj6s84Ek0ABgPpPdpjOfgvyKXgcMtaj1wGREIdIpwySyxe4mcET1d5q19SOgdkO4xySqdtM0wQoeWQ3TNm3aYqiOdDx4ELjhy016trG5ovq7c5UnpmUjbch0IurbmnrLblhWM6V+ZeRX2fPUjj9JzKombhh8rM8pttojOgD53+vh1dmAjM3wShuf8WB83r+Av5vyMbPMMswayg5l9djEgCI3PY0oG5fVMVM7M8zbF6h/XDvIHmzfDOEpMXib0PbwSEPlz6i6iEA0gQfM5os4AQsJkCMG7CWVF8uzEmvr1q+ojOiuKQB0Ac0xkv/Ems7mjTuOhwxw/7qkqM8kfnSjiRdHCJQ+iqWhUmgW3Iuy4I9O7QlsP3HUob3yx5EKXzmU21Pif83eAwBKZBzOfxBLCwEh/dDpOhZUzErrq6V1mp5IzMN7caod9MtP+Zw0HyoKUXWilN6FMqk4qUHI/DCYigin15tiqpNOZ1vPpKztctZaN7WbN80T+rfs4jf4PCoXn4SdlM83n+cvTcPM9vJZL8WDzP5P/d7NWO3eKXTws3oe94cXg8uuih2k55qnlVJAJH+ds9BfIfWda+3bKez2acZCLG5uSvnoqZhvn8LaBhsWUu4KuboM4TNqrBfAiB4FYV+aD7IlsKmMVS90dvAnZ14gjGnEPaRQReJtaMgosEXSpTNP1WUK4qlerRyaNM2axb7lDtMGkGngT4dMEbdxa7GLc70JPGjP0iawWLMkng3DiiPBJ22zU2+67Sbn9eOmdYS7VN5omLhDpfQMHQXfkEhTHvo7EYjIs8GA2DAj/yZPxUH2RAANvntwmfrYQf647FXdjM30CCEWn8AFcfZt75o1jxgeSiT0nk9XhBAYN6M1oAOcq46vIm/qBU9599P+WffmfEx7hv+56Y+2bRe6QZo3HlKO6Sx8IIo1A7hRksIncF1jVd1rFRjigSxW9NQvjUh1MiS00KNvaFHsWp2sFJcSrZtPMfvaq4naAZsIymaIAWpOuKRAgcqiRQC+iI1zLcmqTp/9psa6mflS619SNsQEELJTMDtugmiA0AKeAQVh7NmiPBe5KNcspjYl58VJwcUBlO+w+bExJ590orQKM23RJKZ5/Y6WXJm6cUFoJFJM5QObZlNeN1lVAGOwtQHXL5k2R5RRB4YnSOtlFqtoIcncXShiTuOQymyeyB3W3bUP5scg1rKCe6EXHyX0K2tEs5FOk7ZI2rlTY10rm6504aucv/3a3a/d/drdce2uFg71EbcuJehjrUOfm4AnIN+InOca9IlShJ5WUsEmNZEHiOc1RPr+wxgW9kcRYH3xaeHpQ+o3wkfKla8R383mQ6c2p8HQ1PXnc4EEkhwVBy5YIuGcEN05xQokkqga66OdhQB9QUGDDRARP8NiyzBhHEQWJQEd8HHAxE4oZPCPWH9xoWAvWUAcNXAMleGwR5J7JLn3Rntv9LfxRnskuV+7+7X7Ptfuk0gyo4pWi8ZJad4FaZouV2laUCFPtsyWXHZ8V0Qr2BnLMFaljBwqk7o1sdwjWzQd3nTajY5bt9t13jqyjqxJs35UKfr623wdZ4usvKYK863mUeWXiQg/pEgCUC4Zh6FTDv8leIrgollD05PhZpA5iPQuw471zjp2HIchu8DgqEZIsoQhg1JCKgwMWhws04ElHe7q2y7AVHmhSlPAE2+D4SeBjL4LxsWLXEC/0dLoUm6q/tpYK1k2io7OSrIEGH2noz7u4ae7LmI+6IEQ7BSs8xuiUz1FX4Tk2RA5PkeOGab5ClzoGXJvbYrvUmIw2oiRmuAtgV612+EBKABsCJTNynDnHp/v8fnex+99/N/Dx+/x+X7t7tfu+1y7L8DnGg1tx+dQYWd8DnVrJsuw1Bndh/Jnw3RaKpoCUm8W2pSE4eQYnHAFqBISNKVrkxY8nsGPw5WPdVUGm0L9ip4k8qFe+qXwZ5gmmJ7HGl94tTQHJQgf6FPh+8YGo4PZAWqBgdlyEvXJN16zoQapkXAjD/VXGTsaQIlaXzCTf/j2ZP9pHtkyTMC8UTcHmJSldYleY243bCT+Ial2jXRnjUfg7SbyH5/jR18XsoUP1ckWPjaJ78mxoD4DKlfYQ/LvcLpgvinbEubrRmJuOFmpboJzfHtXrDNCVK4oXKuZexrcydXXCLrCanX2reARflxPhxtff/9h/A2bIhYlW6DuWtHXunF2DWpEtq6bBvqxEbmf/HKtbukoBdcWc30QCtN3JaXZpJfgBIZgtUns2EiQocBWu9/KwkvtttyMhB/Tn3qR0F/uYR3Noro96naR8sULfL2WiK/S3gzVm0G94Y0wJSqUaG/155g2LHDsgvuSpPXqwVV/RqE/3GHBG+x1lQaUhKajfABmp7P2ajpK/RnYX5mOX4IPKvO21Iwpu8bkjK4HGzB7FoZS/DdjqDq4VG6nCay0V5NF6b4GrQijbhZIMtSQhmcAbCT6Cvcr8Am6bUItIQC6wFHL9leaWbALv1KK/q8lnun1LXhXrOmE9guuGlqhGQc0cEBD2Qmp6dcZoEAsZg0CD+qDEFKAXj7/ZAk0oQW7qPraaPmp+0Nqg+7DBlKpF7k4UT9OciOonxgVYO2sDphpRN3ZkSB+T6P7Qg9WElYaL1iV4Dq9fgiOc0Vuit4sXoXO9K/GL3LczcMqV4G/fGsrvcWS/HXs7n/I4u0tzd/R0mgc7KVfWKx8YodKrhDdepBPUsY2/B9KaaUS4AbInF9aWexm4fMYdZrWtD3zBIUHFoJTuv8B6pW6hgghMS5+2ARSR1O62SsCgjls6Dyfrrr9oO85iHDvhQkV0Otvod6E5V9TnqYTx/CLrSTArwSAiGTOOKjHM7PreNJOlBHSV0sogtRtCFmrdEWi2qAo6NMBEc3llas/5ixM4jNjwRym18eBICk9W10EmDMyFD5pGdYrQ/Tn+gbNMfDOItz9gQUFMCUKI1wMxms9QmeB+iaoFkbTQ91IHmJd/LwKmFfK0KjBng9fLUIZw1a10C/dk7fhku8VffqcR87/sOu+tYtAbH+4wIAVUpyo/Yja+t1WNmz9YKMwA7aw9PNnjGjgPugRX6vbGnGDATJGNc6vDH2Cuf/4veAb5fBR4MZ/9bpzvcWv0Fd+X8Lkn3bb907M0d3lX8Db+7u8+0mxbLjL/JXCeV83dz8hlPRi8lfK4f/XldtPyDG7kvyVgtzfn/3+7s9+Qh3SS9JfqQ37S7DfwSXYT0x/fu/5KxVgf4X1k/LN7wvP5XuXx+Ap7g1olmwj4VbVTB3MFVqtpa5gL9lhyXd9gP+P/wcZ2zNM
|
|
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 '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 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,"example":"2c91808568c529c60168cca6f90c1313"}}></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,"example":"2c91808568c529c60168cca6f90c1313"}}></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,"example":"2c91808568c529c60168cca6f90c1313"}}></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*","example":"type eq \"Identity Refresh\"","required":false}}></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**","example":"created","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs><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","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><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\": [\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 }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |