mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
121 lines
55 KiB
Plaintext
121 lines
55 KiB
Plaintext
---
|
|
id: start-report
|
|
sidebar_label: Run Report
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXHtz4zaS/yooXdXtTEqS9bJl+Z8rja3ZaNdjO5K8s7vO1AQiQQkZCtQCpD3aKX/3626AL1F+JrnLpuRUZSQSbHQ3+vHrJqBvtZgvTO3kpjYR60jHhp3xmLPR11hzL5aRqn2q13xhPC3X9PWkNkmUYZxpGs+450Xal2rB4ohJtU7i9I4vYi5D02TjgKlINbxIeYnWQsUs5uYLk0Al1IL7G6YTpYjEUigmkUKcaGXqLIIr+k4awZS4s4958Egs4Fnlp+OatXotWgvNkcOxDzyamOvYSgT3jICJZbwBMb/Vro3Qp5GKxdd4mMRLFN2sTyzPJ5Z47dM9SK3FvxJh4neRDw9+q3n4jIrxI1+vQ+nRbAc/G1TKt5rxlmLF8VO8WQtgIZr/LDycvay9M6sVxudRripQ3VywtY48YYzwUR74AhLFUhikacfNiHI2g4k1KA3GCpWsUI7h6enl9cVsCpfGZ6OL2Xg2Hk0/n41mw/F5+WL+5R+fryaX78fno8/ZhdFkcjmBEZeTq++HF59LT01Hw8np959Hf7+6nMzg+/XF6eVkMjofzkZnn7P5KzYDSofFhRV3Ym1QZF8EUgl2t+SZIswySkK/pAwwKrQLNjkbMVi6W+kJ1I/4ylfrENWwQ9T7eo3rRbKC9SL1RUpcBrT6sYzpoYKqHl+vYUqHBZFmQ7D2BAx49JXYfZOSeVuz9iK18HElChaC9hcl2hMXfCWIfMCTMJ523yXeFxGDrdVztnYu20sYHPvwUaLZpP6XqvZNlfY219us1cHowWFDcAn/UoWbh3h9PY9V3p7iaRcLj9jwK/jasCsdBTIU+YWR1nB/i9mHZq3YAkSZCMIPWMOtmJIpPGUGFc9j/812e9rLJLzU6yVXuxagMuNbCrDXKreA1Pjzh3ay9KIF3A4nLxFmKrj2lqkrpjyVKG7zAgFdb3Yq/1MhopQCPEzb8Qbt49bxoC/6/V5n3mm14dNxu3/cCfqtw/mg7OEQ4iGDTj0plCc+RvqLz3dNeRLrRNxvSziDQGfDesPqgK34+o0vKRVzvXnL7mS8pHiYBThIjcKH5QlyE3XBE8g0a/cwSapumxFdCsIo6WSmIFmwijRJuQyK6S1ZrWB+9LnqMJ0m2lseJmI7X+0OaqX4vFM5lehjVUZ/xWV1itTCrCNlrCydVsvSfST1OsyRpmDAFk2KeL9Bmv85mjNYHcIv+FwdFhnEIhcLZSC8jReKataPn8j3P1wPJ7N/woUfri5P4Z8PoOdLVO4P16NrcMnZcPrXai7GVWFRQEZUZCxRvtDhBnXiUm7Vmtg4Zl6aojn7VwIw69/0eJ0hE0jMcoGkDX5FpBjA4iwPzEZ5mZ7z/O24hiWU/i5pt5CEkuDFlmMCEBJvMElWGUihy8R5p3fstY8C0cG/eWfu9wZH7cPecbvbxr8aWU4RXO3BVBVMleZ/aoXO8m+pmaWGlOh1ZMjsD8AynKuZMgdDB1yA2VsJoN+RkHnYcTKYjYnFqon8rTmWFTb8VtlTSRjyORK3YaXMLj6VTmLpkHEdOJ5lwMRXaSpcJj7UKS4+AgchTxSEBv20eorzVRyMkT3zONoyYy+MEp/7K6lwMlulPMNZLH+2ZMLl8LG4qdcgU6w4hLgafm/EknBpPlmn1Wk1WoNGqz/rdU7avZNWq9k96v2zIOfOubf1vHOanQxSuZZy9zgjh502MeJFOOgBLbyeE0e2oKzH2Gk3291+kR14bgqRPTHP4SqNNNPr09PRFAPCx+HkYnzxZ/iUho3ZaPJhfIEBgb58uHIBpVqVV/g3xEjZjqaJh5aGHK/gX74oJhrIydphlSLlc7D+1GDTh8BHfUyN4KQQe3JTbjL2XkerSniGMGXWkCcBATPwEsESk/Aw3BRi1B3XmI8pZwjE22XWb0BiCf5uduXe56XNh9OgE6tZyK3ji/eXbkWy5SiCRHsHIRTyWphuHkWh4CqHfLWTgIemEnfeh3wB4VpghyNlgHoiyopfkp4owGROSb/mdKniS/M5TPVFbJ5W5AdHzN5+MBMjtA2iMIzucBS3tcQb85YFNtiDHWV474QN6+/qpxRwIo+H8t/Cn4mv8fOZ8WyHJ4fLREewOccsGHK1SNIF/2UcOjBKfagnXWm25RYAi2DFTB2zjBLomYCxX2v2vjTrkG/O+VyETytqGMP1eQIgtHC9rA9GfZR03EPZtUx2SkkZfRjCJ0dts4wCU0CiMgUpMBuzU87yFNSbzKmaSolUqIcKkQlrDt8nvfPwakfASOe7L5WCkV7gcqoGfkBWQekLjTH0xUjj1HU/dZb04m30RdkfzB39sVmu3dB2JmQvD9RvDiFt3O1n1m6TvPxx5th8WSGHT56JwNW+DxeRWXGfVS0I958G6AW4gxm4uxOZVKz7pSCyjCHL8K6I7mqD426nc3xYK0KhnXwRUCnhlB3DHIAoZuObT4V4gl/KvlG2x6I57rQeQ00S2yP5DSyi0r8pGUOpQ/PbGEA70+COIOHFjDo+FItYgMBkFHITS89xBhH9dPq3rcVHJy4t+ax12Bl0KyveeoCRrRXfGtZt9g7bL1pxEuF7bpZA71C0O17QH3hHfX/QEZ2u3/OPvXlXDPq94Ljvt4964vjI7/Hesd/tCC84Hhz1Dj3uBX436OBrkqL51C3tK665TTBeFCYr5CJNJqiReiC1Id3UUXn0QazAVOpuXeo5v00qVM7TlgZiYVHHN0x1TsCzadb4xqfO12vTdB9dV9HdQrNQEM1R9lrur8j6nRKa3u4MDoU354feYQ/+ugNvMBhw4R11jz3R4f1+PxWsdtJvwV8f+3M6Lku1Fct3OI/NTL1dnaTTUGIgt23hBngMLh5W12lZR2+O2DzyN4ixpALvkf4vai9t5Xry1dPIf0ZKfi+VaCw0l8ghQUuAMT41BW4lvblbRVq4gJlGyioERU002+wd90FeK9+pEwazFHjbF6A1fkELxz0CUTnL1TumFX3B50etQacXHPU47xz32v3D+SDg3W5rcDgYvKiW+bMAG5Iey1AlrBUH3RMDFsk/G29ZRPmMQiNHn6mYKf5GiFoHCP7u9Ir1+hkshdi72FKCalxPKwAjhcfiUsuF3NmaScuZs9H74fU5hujJ6Ifr0RQ+Ia1KGTlUjNwPWxBoC8vorgif77hhRoSgDuE32XeO6ncgEFemOFCaQnplrjSBJ9zsO54okraxuuhKKZ5/I5uiWYd60WBrPIYYbhF9ZNP5d0MIM+u4ce40+R1Um9wX+m2TDTPwxyiXIW7cUBvT9/PGWJCAKwsqG7Bxq6K40iLLVbkN91Kodl5cFHSOZ5UuQy+GmphsouSFebVmWXTrg2UMzVMtYlKlkUo3KsY3+R6V21S/QFqEYM1kbNIWHC6XgcCj0nFZxCoiUAp3rsA6iyO65/HEPMPvrkIIPw0SLbtxK5zzGczDNhrRaqTL5CKSazDQw25UtlxZPwLqzdDf++7ed/e++0zf3b45ce/P3F2CPu0q9LlW7n02Js8K9NFkPSpi6SDbd7YLWce2gINIf/k4A8f+gtt9DBNf1/gq71fER1lTbrssTNfDXp+7TUdZ6s/XAhkkPVoJbAvohPjOOS6gxG51tveRnkswULUDIkLU1GwTJQwKj+xVJDd15kfCqD/FbMkhPlrQbCMgzqr8xjqSKt4jyT2S3GejfTb642SjPZLc++7ed/8zffdRJFl+R+FwUt5/Bktz91FazmAAS3dysczlsuZzEa0gMZZhrFoZOdTmnfa8HfQ90fN5zz/qDoKOd9Thh/12vz3vdfrlDmzux5mTlX2qsN52He1WPaFvAcfRzikTR5Ffbv/RBu8AwxqGngw3g85BpZ8y7NgZVLHjLIrYB642KUIyJQypch1hTIOxKxyr07EwgLMFxEV68y6BLzQluRJARePGs1CuJDkvSgF09aYxDGIQxTpKvgHMzSKVFybAIUWCMLK7/e+4BCFFgJgPKBCCXUB0/hXRqVuiX4Tk2QQlPkeJ2eirZ18OZsj9cFd/dwzMa4wRU7vADzR6dfrCPlFQENiYleHOPT7f4/N9jt/n+D9Gjt/j873v7n33P9N3X4DPHRp6GJ/DgGfjcxjbbLEMS72n3Yn/1zCdXMVxQObNIo+Oofo5BidcAaaEDK0jQ0GE49HQmtsFbg50Qgf5CA5aThIdwoBlHK/NycHBN1ggWJj7Jl/LZroTS0V3TS9aHdx2d4Qb3BdgXQsClp/Q9jU2vBq7osLuudESLdeGOZqgcFoGbRSUTQ3hR+krt+N8EyUQ2IhMHY+hOCuiy7hpBUqIPxm3SQ+VUpERZLvW4f1T8vyt+5gclsgDcuxS36NzwXgGXG6Jh+x/ys/9ThFr29krp3/z/IH1Wacy2SUO67B3gmsoBOwrizd/+Th7yxaIMMnDE9q6LyTtreXsCkyEItgwbd/jQ5RUdJQs7H7UYekFCXoMC0IQmP2opkKwm/Ts4QWE9gnEYlIpPiTI/fGpT2/SlfHFrQgx6zVzTaLhSV8dgIYOeOm5t5ThqBSQym6Nx72fP6oGO5MYeCRmahzjRKTKjt2sU7l4Qa7XMvFfKbWGpdYgaubtFhdWtTee3XDjgdsiCR4a0tarJ7f0GgV6WDfBFaS6zQNqwvFRfq3lpav2aj5K9BpIr8zHj+rjUkL6LD/GbLRKN8+PmbeMIiP+hzE0HXSDm0UCXvRqtu5w0gZ5RKPTKrDUsFM2ZAPAIPF3Do6hrDHZs26ERSKAacq3LvkTrSz4/E903u2nksx0+QZyJo70I8+8mmecsIETNmwMMI5/dwwamAXfRhnsTjcygNN8/SkSOEYLMc/S2hnVifwBPYOpwQNWiYpZn9gvJ3mAc58Y3cDR2RgIwYilsxd98J05WrQxuqistAuwrcEqv2EE6XBLb5bfrAuFKfL3Ji9KPMybJXjq89eO0g9Ekt9P3P1/inj7SPNHjDQO3WLTcZL/nMkoP97wwoPaDx2Mtz9rAL7zzHPx08d+EcPVaSb7XgP1g3ZvG3N7AUVCDyJNpj8FUfBbC0Cr3Ug6Nyvg/3DX2N+rgcoAt4lnx4SKZNYhj9FNKUx5Symoj7EWeLAlFHV0lWhFoSU9X2ssoQXti9awBhwqTxkCvSb7CIWi8kBuLBJx5wdQ/Tly1eIUDOcK7Y6dpbYImHC1ShT+/AQwkawYB4t/wmB9abzExlWoGZVIJaOf0WHZU2mQQU9AVTSpXNIrcxlM7aHggl0+MReYpXHdblAkrohyq50JMsETUxjbYFy5oniKNjhDYynCNR0EA7ag6CzM8GE8q1AEYsoaXTPSiwP3kDnAsUAEqzdrDN0mFKd0gAIKPqipC3QnicqPfmwdfc66+r/Tn0FyaRLrm4M1tuJQxMTWW7amvXE+j6uBVS3USUuseeHGt2/YpsES7x4vuz30eCIhreDwGxC07Roqg+mIYM29H2hQIMn6AdUXH1hU2idsC+jRsZ8KZfnVJTbDanP3Y0wr22HQ/A6lgP+f1H6E/2r4O1DW1DC24fVvtbRfB2Ms3RRX7YIV7gOKeX//vzeY7Ic=
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Run Report' (start-report)"
|
|
---
|
|
|
|
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"}>Run Report</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/reports/run"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Runs a report according to input report details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"reportType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCOUNTS`, `IDENTITIES_DETAILS`, `IDENTITIES`, `IDENTITY_PROFILE_IDENTITY_ERROR`, `ORPHAN_IDENTITIES`, `SEARCH_EXPORT`, `UNCORRELATED_ACCOUNTS`]"} schema={{"type":"string","enum":["ACCOUNTS","IDENTITIES_DETAILS","IDENTITIES","IDENTITY_PROFILE_IDENTITY_ERROR","ORPHAN_IDENTITIES","SEARCH_EXPORT","UNCORRELATED_ACCOUNTS"],"description":"Use this property to define what report should be processed in the RDE service.","example":"IDENTITIES_DETAILS"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>arguments</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The string-object map(dictionary) with the arguments needed for report processing.
|
|
|
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"ACCOUNTS"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"application"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the authoritative source to export related accounts e.g. identities","example":"2c9180897eSourceIde781782f705b9"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the authoritative source for accounts export","example":"DataScienceSourceName"}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem><TabItem label={"IDENTITIES_DETAILS"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"correlatedOnly"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Boolean FLAG to specify if only correlated identities should be used in report processing","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem><TabItem label={"IDENTITIES"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"correlatedOnly"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Boolean FLAG to specify if only correlated identities should be used in report processing","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem><TabItem label={"IDENTITY_PROFILE_IDENTITY_ERROR"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"authoritativeSource"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id to be checked on errors of identity profiles aggregation","example":"1234sourceId5678902"}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem><TabItem label={"ORPHAN_IDENTITIES & UNCORRELATED_ACCOUNTS"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"selectedFormats"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`CSV`, `PDF`]"} schema={{"type":"array","items":{"type":"string","enum":["CSV","PDF"]},"description":"Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default.","example":["CSV"]}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem><TabItem label={"SEARCH_EXPORT"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"indices"} required={false} schemaName={"Index[]"} qualifierMessage={"**Possible values:** [`accessprofiles`, `accountactivities`, `entitlements`, `events`, `identities`, `roles`, `*`]"} schema={{"description":"The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.","externalDocs":{"description":"Learn more about search indices here.","url":"https://documentation.sailpoint.com/saas/help/search/searchable-fields.html"},"type":"array","items":{"description":"Enum representing the currently supported indices.\nAdditional values may be added in the future without notice.","type":"string","enum":["accessprofiles","accountactivities","entitlements","events","identities","roles","*"],"example":"identities","title":"Index"},"example":["entitlements"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>filters</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The filters to be applied for each filtered field name.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> Filter</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"FilterType"} qualifierMessage={"**Possible values:** [`EXISTS`, `RANGE`, `TERMS`]"} schema={{"description":"Enum representing the currently supported filter types.\nAdditional values may be added in the future without notice.","type":"string","enum":["EXISTS","RANGE","TERMS"],"example":"RANGE","title":"FilterType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>range</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The range of values to be filtered.
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>lower</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The lower bound of the range.
|
|
|
|
</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></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"}>upper</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The upper bound of the range.
|
|
|
|
</div><SchemaItem collapsible={false} name={"value"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The value of the range's endpoint.","type":"string","example":"1"}}></SchemaItem><SchemaItem collapsible={false} name={"inclusive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the endpoint is included in the range.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"terms"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The terms to be filtered.","type":"array","items":{"type":"string","example":"account_count"}}}></SchemaItem><SchemaItem collapsible={false} name={"exclude"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates if the filter excludes results.","type":"boolean","default":false,"example":false}}></SchemaItem></div></details></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"}>query</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Query parameters used to construct an Elasticsearch query object.
|
|
|
|
</div><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"name:a*"}}></SchemaItem><SchemaItem collapsible={false} name={"fields"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. \nA field's availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn't use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. ","type":"array","items":{"type":"string"},"example":["name"]}}></SchemaItem><SchemaItem collapsible={false} name={"timeZone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The time zone to be applied to any range query related to dates.","type":"string","example":"America/Chicago"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>innerHit</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The innerHit query object returns a flattened list of results for the specified nested type.
|
|
|
|
</div><SchemaItem collapsible={false} name={"query"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries.","type":"string","example":"source.name:\\\"Active Directory\\\""}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps.","type":"string","example":"access"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"includeNested"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whether nested objects from returned search results should be included.","type":"boolean","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"sort"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The fields to be used to sort the search results. Use + or - to specify the sort direction.","type":"array","items":{"type":"string"},"example":["displayName","+id"]}}></SchemaItem><SchemaItem collapsible={false} name={"defaultS3Bucket"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Use it to set default s3 bucket where generated report will be saved. In case this argument is false and 's3Bucket' argument is null or absent there will be default s3Bucket assigned to the report.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"s3Bucket"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If you want to be specific you could use this argument with defaultS3Bucket = false.","example":"the-dev-bucket"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Details about running report task.
|
|
|
|
</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={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`QUARTZ`, `QPOC`, `MENTOS`, `QUEUED_TASK`]"} schema={{"type":"string","enum":["QUARTZ","QPOC","MENTOS","QUEUED_TASK"],"description":"Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task.","example":"MENTOS"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique task definition identifier.","example":"a248c16fe22222b2bd49615481311111"}}></SchemaItem><SchemaItem collapsible={false} name={"reportType"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`ACCOUNTS`, `IDENTITIES_DETAILS`, `IDENTITIES`, `IDENTITY_PROFILE_IDENTITY_ERROR`, `ORPHAN_IDENTITIES`, `SEARCH_EXPORT`, `UNCORRELATED_ACCOUNTS`]"} schema={{"enum":["ACCOUNTS","IDENTITIES_DETAILS","IDENTITIES","IDENTITY_PROFILE_IDENTITY_ERROR","ORPHAN_IDENTITIES","SEARCH_EXPORT","UNCORRELATED_ACCOUNTS"],"description":"Use this property to define what report should be processed in the RDE service.","example":"IDENTITIES_DETAILS"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the report purpose and/or contents.","example":"A detailed view of the identities in the system."}}></SchemaItem><SchemaItem collapsible={false} name={"parentName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Name of the parent task/report if exists.","example":"Audit Report"}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the report processing initiator.","example":"cloudadmin"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Report creation date","format":"date-time","example":"2020-09-07T42:14:00.364Z"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","description":"Report start date","example":"2020-09-07T42:14:00.521Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"format":"date-time","description":"Report completion date","example":"2020-09-07T42:14:01.137Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `WARNING`, `ERROR`, `TERMINATED`, `TEMP_ERROR`]"} schema={{"type":"string","nullable":true,"enum":["SUCCESS","WARNING","ERROR","TERMINATED","TEMP_ERROR"],"description":"Report completion status.","example":"Success"}}></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"}}>
|
|
|
|
List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`INFO`, `WARN`, `ERROR`]"} schema={{"type":"string","description":"Type of the message.","enum":["INFO","WARN","ERROR"],"example":"WARN"}}></SchemaItem><SchemaItem collapsible={false} name={"error"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Flag whether message is an error.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"warning"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"Flag whether message is a warning.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message string identifier.","example":"The following account(s) failed to correlate: A,B,C"}}></SchemaItem><SchemaItem collapsible={false} name={"localizedText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Message context with the locale based language.","example":"The following account(s) failed to correlate: A,B,C"}}></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"}>returns</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Task definition results, if necessary.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"displayLabel"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Attribute description.","example":" "}}></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"System or database attribute name.","example":" "}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Extra attributes map(dictionary) needed for the report.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"progress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"Current report state.","example":"Initializing..."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"MENTOS\",\n \"id\": \"a248c16fe22222b2bd49615481311111\",\n \"reportType\": \"IDENTITIES_DETAILS\",\n \"description\": \"A detailed view of the identities in the system.\",\n \"parentName\": \"Audit Report\",\n \"launcher\": \"cloudadmin\",\n \"created\": \"2020-09-07T42:14:00.364Z\",\n \"launched\": \"2020-09-07T42:14:00.521Z\",\n \"completed\": \"2020-09-07T42:14:01.137Z\",\n \"completionStatus\": \"Success\",\n \"messages\": [],\n \"returns\": [],\n \"attributes\": {\n \"org\": \"an-org\"\n },\n \"progress\": \"Initializing...\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"identityDetailsReport"} value={"identityDetailsReport"}><p> Identities Details Report task result.</p><ResponseSamples responseExample={"{\n \"reportType\": \"IDENTITIES_DETAILS\",\n \"taskDefName\": \"Identities Details Report\",\n \"type\": \"QUARTZ\",\n \"id\": \"a248c16fe22222b2bd49615481311111\",\n \"created\": \"2023-09-07T42:14:00.364Z\",\n \"description\": \"A detailed view of the identities in the system.\",\n \"parentName\": \"Audit Report\",\n \"launcher\": \"9832285\",\n \"launched\": \"2023-09-07T42:14:00.521Z\",\n \"completed\": \"2023-09-07T42:14:01.137Z\",\n \"messages\": [],\n \"returns\": [],\n \"attributes\": {\n \"org\": \"an-org\"\n },\n \"progress\": \"Initializing...\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"searchExportReport"} value={"searchExportReport"}><p> Identities Details Report task result.</p><ResponseSamples responseExample={"{\n \"reportType\": \"SEARCH_EXPORT\",\n \"taskDefName\": \"Search Export\",\n \"type\": \"QUARTZ\",\n \"id\": \"a248c16fe22222b2bd49615481311111\",\n \"created\": \"2023-09-07T42:14:11.137Z\",\n \"description\": \"Extract query data from ElasticSearch to CSV\",\n \"parentName\": null,\n \"launcher\": \"T05293\",\n \"launched\": \"2020-09-07T42:14:11.137Z\",\n \"completed\": \"2020-09-07T42:14:13.451Z\",\n \"messages\": [],\n \"returns\": [],\n \"attributes\": {\n \"queryHash\": \"5e12cf79c67d92e23d4d8cb3e974f87d164e86d4a48d32ecf89645cacfd3f2\",\n \"org\": \"an-org\",\n \"queryParams\": {\n \"columns\": \"displayName,firstName,lastName,email,created,attributes.cloudLifecycleState,tags,access.spread,apps.pread,accounts.spread\",\n \"indices\": \"identities\",\n \"ownerId\": \"95ecba5c5444439c999aec638ce2a777\",\n \"query\": 700007,\n \"sort\": \"displayName\"\n }\n },\n \"progress\": \"Initializing...\"\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> |