mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
71 lines
35 KiB
Plaintext
71 lines
35 KiB
Plaintext
---
|
|
id: show-preview-data-source
|
|
sidebar_label: Preview form definition data source.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtz27gR/1cw7IdePKZelmRZX1rHj6k7TuxaymU6lqcHkpCEC0UwBGlb5/H/3l0AfImUJed8TeaqfIgtYLH4LfaBXQjwkxXTmbSGt9ZJImOxIOciWkjrbt8SIYtozEVw4VlDS87Fw3XE7jl7OKUxHYkkcpm1b4U0ogsWswh5PFkBfADqKTA5ZVMecMXgFAh5AO0hjefwu8ekG/EQ+6ARZyReRk0UecS+JjxiMHUcJWzfku6cLag1fLLiZYhTyDjiwQwoH+2ZsM2856vzPu9b7JEuQh97W+afXfNf+m8zw0xIny94nEr2NWHRsiLaJZJMgklwEcRsxiIiQ+by6RKQk3jOyII+8kWyIEGycKBXTEnEXBF5ksQCfo2TKCA8IJRIGOEzcnx9QVzq+w0yhtEypoFHI4/IZRDTR6LndpiHY25/PlDko5ToRPg+c9UKX2dKu/tpHsehHDabHrtnPuq8ISn3Q8GDuOGKRZN7QZOGvJlOZrsZHztX/l9COuMBmEswsyMmEz+W7xog9pTwmHBJAhEb2Tnz9kEg0DcFKqIWESkSybyGVaNorpcOutCqaKyb+l1ogOW7ZMEMbGrY6bXgMw/Szy1UhZrCGrZbZaUqrZRMAylyi5tSX7L6IbmFc18Z/YvqP1dExCwIiJjq/UfSnJakqDg02PO0FXUjkzAUUQzwQAVKgCmwEg/YDQr1wV5hCqIjhojkEDns7d1TP2F7e0Oyx77uk1m8T+TDPki4p7t96jB/fbdMnMt1FHV2Uh8QjJpKcUBNDKzIxFosifo0sawNFpBzymwgVfoLFvAvbEV5Rgpdyf8FUWMInVEeyHhrmRTPskRGQZtkMCPvNBmT8XvhLXG6MmhsRbWjog0hCenSF9RD1G7EaMzAh6crgdtbwjzcJUaMfcsV4LtBjDPQMPS5q/aT5q8Sp3kqiBtGaDsxZ1KhyTeYSh+wnPJZtZ3OZhGbKf7vE/cLi8/RLquyHdfSpdIWuBBHdWv7JmoBiytOY1CNk8RMNlxfJB44a5zIBhC4qIaX9FcPARXKA4+7Zg1KqC90B8KkEDJBH7BVGGpUCQTPIrpbi3uw7lwtDmibx2yhuDLYaLCbujBQwgqC8zMMYtAgEghFEB3u9TBghxx8toCfKs7lLKHv3rRGQjPYw3lqpcY5bRQHV600LxkxGrlzEI49Hquea9MzCSqAVoix8zjrnARFsEXSs0L7JMhlKNJcZK3A577C4V6PVZIWO26EQrpXbPvMfc+FWIvaNKtBo4guV0zA6BOphPMrxOSxol1V+1XWpzUPCZhKRpg3YhjJrxQhUXEWNtvTs4/ji/G/15AZKSEaHZ+cnI1G/7m+uTq/uDxbQ15SCMSvq083MGoNsfZWWIybq7UMcbkmgYJ4efYBfq6hK2hMGaG22FQ4aCrDhwaDDX7D6eFHYRI0y9xrC1w22uqfcjmLRphbF9qh3r8qJqi2DG19MXuMSzFwb0OgM9tN7gra1lOqkLpf6AzbZzyeJ45KWrIUpilDGzcY2fTEAjZInAsFMUn5mRbpVG85eUlyovcHmDPfReqd67TUr0Usci53Gx8bjY/HFyfr6XAb4C744sfx2c3H48v1lFgRRAH1gefZ8c3JP17gqcJLwRc0CGhIZ0EfUEzK1p7RbbT17ypW0WTKJP9j2/ljpzPV841OqGCu50q2plpkKAKpk4AO1KMVu71RZSFaa6g5Yi5Qk4yBWESmZfrWmVh5rkrFf2Pg5emh+SyBO3GWpIk47ByHbD6tHgY8NxGbrbERFnhqEfEsoZTRmWqkbgF0OTUXqvDI8qFaS9PxQIdCyJ9UIlT0kadJOtEEDzAmlikHhhPr2J+Cakin12OHbW/q9tnE2p9YaV1SoGkUaP4OKWEMVuA3TLKxlEIEaDBqtI4jOLTjHrUHrUF30GkPuodur9UedDqHLvM6rN3vH/YnWGqU8fDfYL0ceuR1Xa9z6NE6PEDTKNK8AZ4p4nGreIJYBFD0k1Z72j9yD1gdHkPTyGjeAs8R4GFVPJHHfJ+STpsdDlzW7vVq8GiaRk7zFvrqAx5agwfioCeIN+gNOk6ftQ/r8CiaRk7z+/EcdDv9/qDGfpKI+ZwS6i140IFxgxo8mqaR07yVPXcreN7TyKERJYcdl3bbg6nnVfEYmkZO8xb248D6tNbiYaxNO92DPqvx9xRPTvMW69OD9RnU4Fn6jJF+r+Mdwlyd6UEdHqRpFGhei6en8Qw6OZ6B06es6l/vI+F+Ieyw7/Sgv+t1j2rwIE2jSPNWeKaA5+7ZKhSzqzt1eftQuKubh4Ka7l64WevzHyyiPS5Dny7xV+yEmjoiD3MWwN6mjs3U2R2MFJpXNa3KdxWo72FXkXjShuLbuu61zWGK3QL19zyvbx+0en27e9Ci9gBWzJ66rntw1HOcvttbSYwUbkxr0+WuijYyPal0QFkVDj6KB9Wtu2ABPA6+nkApjeeSS9+cTc2ZH2bnkkRERKtvutx6EVYkSOGhEErrVQl+xuYUvqJBJJICMopHjJAsxFCNKKVkKtLakVvDYrh7dLvdAeySXZe2HdrqMsaOjo7oYHrgeiuwFSaVGb5d4lmfnWw4MzBpzx+QpK7N8jBJhdm6dWnoMWgjisAuHmCy0lGhcN0kwqT2FWnny77ssRjEOBEe23Q2eppTAvAFOB2sSDFapCubRxGzCGcozAc9IPOg9AQej+O1tFnCa3gT5NuwqipZiUbCpX6NxV+q9nQ+tW6QR+vWstUG9qfRhnrbDAPB9XRXEZ/xYN2kutdk0aGAaOX4xuskptPzNE5oiA/ggdrVlGZzZKdn58efLsdbYTOI0ILxMKGCbAyt2VmsGyfUV6cOCAebtArMypdAjNH5uY4RSLQBDc6ztU/T2KcS6PQvzQfmWM9ldh9SO8P4rA6CV2z1he+wSiEyH4tLFAEuwH7hbbL6cUp5qjxW+2x7G5+lSTwXEf9NH3nvPHfnuTvP/e6ee7CN56rcB+x0wVWeKXfOu3PenfN+f+ftbuO86AbqTsxUJMHOY3ceu/PY7+axnaOa5RWCLGiwTGta+SoXLTrKNh6ynWeUfXvlu8ysL52vaA16pYmL3fpS4Yplpl/akRGL7iGtONvCMnYBZBdAvm8AKbv9iniZo69eZEtHkSTgX/G0UR9rchV0cjGPXK91wKaDFuvTbqfHnL7Tbjue47R6h67ndDeJXQw03y68ilC9NcdvPPVaqb1W62xXBuxiwv9vTPghkgrEwcCaeLxUjyI+gYOeoC8+xscJXk6/tWQ4VIfxQ8gyUPg7vJRbe/fipYsdaPkLFs8FvtAAI1KWj08shtZr72FYiBnDiH7HkUQ+MElvmD9BGKFB/NygIc++xgvEg1KVA05vrYJPLQLtBgmUD+sJEPQ9jTh1fBMbFHNtjubGvpXp/0XOqAC0ziWIQDSbfQwJHN9ILHUzQAwhk/urVNQNde+mIh/I9Snyn3+/LJrRGlnqlu/F2YCeANIVEVGEu9zERhjG9ewVQ8tDOx70diqTXSFZh7xnNIINJBZfWEB++ufn8TsyYwFe5meeebXAwDeBhJJrMBGBu46+0WgGqWcBkUhmur49Lh0rq7x06oPAZBKMGCO36eXJjxDlbs5GY7WkOAib9Ta1/fsGWhr3Tr1RWIgI4nqg/R1aG5PAJqc80s8fpKIxIqJ0lNyGqVy0INe3gvhLyi395ldxw5cVJRR6aW9dn+O+48KujSyoL9VqffPkmp9d4GfPIjAcG7muYsCVMDjKXwa4qda+GUeJn438yjgmwec5d+ekPIzoiEbkXCS+Ry6IOxdCsr8RgqaDbnA7S8CLvhnWA05qK4+wO60CJFtPaXM7kUzhuwTHCLQxUUcksd6WBYEg6mmX/EVpFnz+F/UE5peSzKr5FrZ5pPSE+4pHOyuYcUIbJ7R1DJAGv87N0LBwdwMZ9CMJZQAnuf5VJDBAC3FP86qN6op9U43BrcEFqIoLbFz6wzAPcOlbLtWB1BkNhGErvfWP6wafieGFu2RpsdJNe3UFq3h9AWnMyrppvOlYRPHDyYsSH+d5+FXgL986Sq+JJD9O3P1OEW8Xaf6Mkcbk2ljP3uTv2c7SsmT1IVn+dGzdY7FNr7qy91mrD6yKj3iKj0zMowprr+5BQno//1m9/JqKYj1cdNT3JuesxIVPeHY4Z1K9C1bxRh0JANb8m4Yio9CnsaomMDK5cw6GARV1yAAX5K/76B1ioaIJlM8YwqAUVYxm6sVfBMtOfepwH/ipF8jpzFQ5vU6O0Tbxs0zUmqgHg3MazFiDfMbb3i6sAFbuYGLY9yvYowI6Auu6RuMkp6nBQuK4WCRQriwxtiQLQsEtNli1x6Wb6OAL+g5YuhZCpa/ZqDQSobugCOoMgUFBdjXFM1COFmNtORfYbno+jGYyzN6H5oLcMJ/qO177K6XHJt7gMTZexVPnCgALb2XlM3y4GFc4ArPAlIcimjXNINlEWrx6B8Jr8zlotBstW5U80I7lIxSjBeZbFqAlm8y2MqxBmmBw+rwh0TWRrk1vrdXaFLgMa/5kQLE8BSebY4ELo5+eHCoZ1mvP2Gx8DIpWWDM05Pzt6wq07Dxs9y7/9e/ya/X6hWF0S/8QgrnVaak30tsrY/dK/o97Jf+C1vK/YPCNenvd2/YXkKRP53Mcd/mxyis9+6cb86TqHan9uyK1MNLT6aCEIluoyt8AuYMxc0Y9Fil0muxEY7DV5p6zqZy84yLrEXiCEsYv0t4VDviur0YY7R3zZn+h6iUrog/QiP8PrYml/o6BMPeJ8REVtuNl+GCW6ENWzTetvuqKD/PL8PYOyP4LbZ5xXA==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Preview form definition data source.' (show-preview-data-source)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Preview form definition data source.</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/form-definitions/{formDefinitionID}/data-source"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Preview form definition data source.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"formDefinitionID","in":"path","description":"Form definition ID","required":true,"schema":{"type":"string","x-go-name":"FormDefinitionID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormDefinitionID"}}></ParamsItem></ul></div></details><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={{"name":"limit","in":"query","description":"Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":10,"x-go-name":"Limit"},"example":10,"required":false,"x-go-name":"Limit"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"filters","in":"query","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**value**: *eq, gt, sw, in*\n\n**label**: *eq, gt, sw, in*\n\n**subLabel**: *eq, gt, sw, in*","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"query","in":"query","description":"Query\n\nString specifying to query against","schema":{"type":"string","x-go-name":"Query"},"example":"support","required":false,"x-go-name":"Query"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Body is the request payload to create a form definition dynamic schema
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSource</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>config</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"aggregationBucketField"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"AggregationBucketField is the aggregation bucket field name","example":"attributes.cloudStatus.exact","type":"string","x-go-name":"AggregationBucketField"}}></SchemaItem><SchemaItem collapsible={false} name={"indices"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`accessprofiles`, `accountactivities`, `entitlements`, `identities`, `events`, `roles`, `*`]"} schema={{"description":"Indices is a list of indices to use","example":["identities"],"items":{"enum":["accessprofiles","accountactivities","entitlements","identities","events","roles","*"],"type":"string","x-go-enum-desc":"accessprofiles SearchIndexAccessProfiles\naccountactivities SearchIndexAccountActivities\nentitlements SearchIndexEntitlements\nidentities SearchIndexIdentities\nevents SearchIndexEvents\nroles SearchIndexRoles\n* SearchIndexWildcard"},"type":"array","x-go-name":"Indices"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS_PROFILE`, `SOURCES`, `ROLE`, `ENTITLEMENT`]"} schema={{"description":"ObjectType is a PreDefinedSelectOption value\nIDENTITY PreDefinedSelectOptionIdentity\nACCESS_PROFILE PreDefinedSelectOptionAccessProfile\nSOURCES PreDefinedSelectOptionSources\nROLE PreDefinedSelectOptionRole\nENTITLEMENT PreDefinedSelectOptionEntitlement","enum":["IDENTITY","ACCESS_PROFILE","SOURCES","ROLE","ENTITLEMENT"],"example":"IDENTITY","type":"string","x-go-enum-desc":"IDENTITY PreDefinedSelectOptionIdentity\nACCESS_PROFILE PreDefinedSelectOptionAccessProfile\nSOURCES PreDefinedSelectOptionSources\nROLE PreDefinedSelectOptionRole\nENTITLEMENT PreDefinedSelectOptionEntitlement","x-go-name":"ObjectType"}}></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Query is a text","example":"*","type":"string","x-go-name":"Query"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataSourceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`STATIC`, `INTERNAL`, `SEARCH`]"} schema={{"description":"DataSourceType is a FormElementDataSourceType value\nSTATIC FormElementDataSourceTypeStatic\nINTERNAL FormElementDataSourceTypeInternal\nSEARCH FormElementDataSourceTypeSearch","enum":["STATIC","INTERNAL","SEARCH"],"example":"STATIC","type":"string","x-go-enum-desc":"STATIC FormElementDataSourceTypeStatic\nINTERNAL FormElementDataSourceTypeInternal\nSEARCH FormElementDataSourceTypeSearch","x-go-name":"DataSourceType"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Returns a preview of a form definition data source
|
|
|
|
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>results</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Results holds a list of FormElementDataSourceConfigOptions items
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Label is the main label to display to the user when selecting this option","type":"string","example":"regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5","x-go-name":"Label"}}></SchemaItem><SchemaItem collapsible={false} name={"subLabel"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option","type":"string","example":"","x-go-name":"SubLabel"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Value is the value to save as an entry when the user selects this option","type":"string","example":"e96674448eba4ca1ba04eee999a8f3cd","x-go-name":"Value"}}></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 \"results\": \"{\\\"results\\\":[{\\\"label\\\":\\\"Alfred 255e71dfc6e\\\",\\\"subLabel\\\":\\\"Alfred.255e71dfc6e@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2e16676\\\"},{\\\"label\\\":\\\"Alize eba9d4cd27da\\\",\\\"subLabel\\\":\\\"Alize.eba9d4cd27da@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2f1667c\\\"},{\\\"label\\\":\\\"Antonina 01f69c3ea\\\",\\\"subLabel\\\":\\\"Antonina.01f69c3ea@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2f9667e\\\"},{\\\"label\\\":\\\"Ardella 21e78ce155\\\",\\\"subLabel\\\":\\\"Ardella.21e78ce155@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2e6667a\\\"},{\\\"label\\\":\\\"Arnaldo d8582b6e17\\\",\\\"subLabel\\\":\\\"Arnaldo.d8582b6e17@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced3426686\\\"},{\\\"label\\\":\\\"Aurelia admin24828\\\",\\\"subLabel\\\":\\\"Aurelia.admin24828@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2e16674\\\"},{\\\"label\\\":\\\"Barbara 72ca418fdd\\\",\\\"subLabel\\\":\\\"Barbara.72ca418fdd@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2fb6680\\\"},{\\\"label\\\":\\\"Barbara ee1a2436ee\\\",\\\"subLabel\\\":\\\"Barbara.ee1a2436ee@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c918084821847c5018227ced2e56678\\\"},{\\\"label\\\":\\\"Baylee 652d72432f3\\\",\\\"subLabel\\\":\\\"Baylee.652d72432f3@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c91808582184782018227ced28b6aee\\\"},{\\\"label\\\":\\\"Brock e76b56ae4d49\\\",\\\"subLabel\\\":\\\"Brock.e76b56ae4d49@testmail.identitysoon.com\\\",\\\"value\\\":\\\"2c91808582184782018227ced28b6aef\\\"}]}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
An error with the request occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
An error with the authorization occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
An error with the user permissions occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
|
|
|
An error with the item not found
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too many requests
|
|
|
|
</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={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"Internal Server Error\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
An internal server error occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |