mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
test embbeding
This commit is contained in:
darrell-thobe-sp
104
docs/api/beta/create-connector-rule.api.mdx
Normal file
104
docs/api/beta/create-connector-rule.api.mdx
Normal file
@@ -0,0 +1,104 @@
|
||||
---
|
||||
id: create-connector-rule
|
||||
sidebar_label: Create Connector Rule
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztXG1v2zgS/iuE7sO2vcixnbRpfB8OTtLupmg2uThBgUuDKy3RNnclUkdKSb2B//vNDClZsp2Xdnt324VQILWp0XDe+QxF+S7I+dQGg6vgUCslolwbdl4kgp1wxaciFSoPrrcCnQnDc6nVcRwMgsgInovqBqQPtoJY2MjIDKmA5pBoLONMiVsWVcwNEHc+qiHL9a9CsVuZz9jp+Y//Gh6dHP/MeJHPtJH5nEnLjPh3IY2IgZRFPElYPoPR4dlxB2bDi8LmBzqeB4O7oKQNBrkpxKowFzOxIgLxJBGBF1zKUVHgw7MskRGpuv2LxZvvAhvNRMrx04qKdQM4fc+dVMAzn2cCaPT4FyDx8joBrwLFU1GSbAVWFyYCa8YCLZ0ZtHUuhcUJiRL+99xsbqSartk6B/WQkukJw8/GOUR85mmW4H0fxHgkzI2MxIGYaCNOS3d616VSvRdqms+CQQ++8c/Vt/7rxcpsjwnDWe17XaIfLMsKk2nblO0CnUouiTXESz7jebAo7bc+mVBFijY8KGQSn/AMhio/DCe5MIelV5vDRyIRG4ZPdCwn8/qws9A6Fze+zsaNV3zeHR0c1mTDr5W1z4y+kRY+OFXwWjUE38+EBpOM9CT/6fxkVGPSvHAfuyZVnfH58PDtmTCptDhwWNhcp/I34gFXR8Oz2lwjnv1kXPKXiU1D981KF+uTjYooEta+5Wgce99ty4gkN6wG5MMBe70pATBQMNzWgr9SDqLKyqnieWHEejZfLMN0UqiIorci77AjIh5ThFaEUmVFzriZFlgoodipmOkix8FncgJf588fKQXEYT3v3fAy/LkxHKNL5iK1tfGKpyqShI9RX1f/vkUZKfVqWHMijc1/Rn5fWhiQ5YbSsHEWvEAzNQSSMdDB4vBQfVg1xLoMYJqp4WkK8RRVUXOvJCPHeLHYUMLBbSAOkQ3Le5HQhUDrpj+0mxaNlXetHIyW1x7O4BthfOVzt68nc0nxJNN74lLZyAmwVLTX6VIhc3M9yvJiEw8joKYp9jE4MR34y/7KqnD5G5mwNFfNCDDKc5hjXOTiSRVoFRWkPEOlnJwIv9ydti7Z3aI++wP4arFwnraZVtbJ0+/2Nhd1B/PiFQD4jWDfuRcB2AFCPZ1ARLQwsYWJLUxsYWILE1v80cLE791NLUz8nmHi1uMCNMpsjLDQ4cUN1TZ+mm+Oj+5FWK97vZ1493XUHe/3die9vfFu9Kq7149342i8H0/IfuX8j0MoxY5Hp+z1q26PXV4cslymoDRMxW5nQrndUkJMt9yWKLghTbffC7t7Yb9/0Xs5eLk/6O/8EwVIEaTIzRI84r4vkSjhUBCquR6Va7G4vsfnFQZ3XcFut7sBtCcS8pm9MQbwf8jOKbShKZDeUS5g2FjHtPUs1Q1PZNz5ki5hNdCawROLnMukLCIPO/atVCKEqiZRQkEiY3JirbuRMeZFCmCHOZZlrBFdp2FHsESnxw54zHxCsEOvDKaP4dGvwOv4CZF2qSTcz8pboHQzgFv3TSv2BB+/6u73dyevdjnvv97t7b0c70/4zk53/+X+PsUYYD/AjnYDeGlO/aNQwkBpT3QEHvkNDAKBDLYnAWjyh/BO0wfE4wn2x2roaCs1vbwsF5/zLcYZQHK2uwcxrKYFjfPpihFUeDlaSxjQ3DE+NXIqN9b6snM5evN2ePn+AnH5m39cvhnBJ+S1BmqHCqI1xrAEUSEWZvqWJPYKYKZZ6EYiSP4Oe+G5vgCFuLJ1Qum+2bkFY0JsTXiR5HCHn33DHXXWbGJ02kglypvPiHA7orPFxjgGq3Q0Y2Nu4QatiPzFEPqALA/fe0u+YDPBY2Ged9gwjiUqyRMG2QhM4f45MGI8jjF1HYNJgcibHiQBoGJKAxAQTV8sTblavsp68r7uFEwOkPzxOBlGeQHCkZr1LKyixYvo/QMyO8s1pbuoGY1MOlc5dEUSH3nNwYzGgIUZLKhMQu/gyxG6y0LhUSVdVbHqSyOVuxMnzFGu6VrEC/uEvDtLoPyEpFp14Ub45LO4MLtqRN4o3eQrElykVgtv9lSVu8rEBywhkrjN3TZ329x9Yu6uXixxj79K0GfDHuil8k/VcfFcgz6Gokfp8tG72+/xjtxiYBAPkd59uPDP7IFefM4QM39DfOSW8jXhh5U/3PiYuoLSWQ1foIBkR6fBBCqRiAck91JiMpQz1c76bG+1GUsIULUBIkLVNGyuC2gsEdgr3KFi3G7RfqT6IWczDvWR066Wq4A4q4rDTEuVt0iyRZLtatSuRn+e1ahFkm3utrn7febug0iykoqyxeMkW6QpN3MXaf46assZELDyQTyrUo5ctYpWkBmrMFbQRA7BuN8b9yZ7kdiN+W78amd/0o9e9fnLvd5eb7zb3wvqa/3VMo+rJGvmVM3fzo9kYgBxN4DjCgXBZXOt4+b2H5jXiAmWNSw9FW4Gm4NJryvs2N/f8GBQazw0Oy8Rkm1gSLW0EdY0oE2R1pS0QMDZFOqiYlCqJMiFoSRTAVwMBA1LZCopeVEL4GvmIT0S9YlSBlk1i1RRUoCEVAkS7fbSb7kEJelRKUCwOSHYKVTnb4hOvYt+F5Jn56jxe9SYvfkcCYGJXiH3l5v2d49BeIM1YuQcfM9Gr+t2uIIAgIbA1awKd7b4vMXn7RrfrvF/jjW+xedt7ra5+33m7hfgc4+G7sfnQPBkfA60nS6rsNRbDK7/OUynVPESUHgzHUWFoe3mEoPj0RYBg3h8CCe5BFx/6EJ5WOCJVDzLoQZ41iBMqzfZwuoI8MANBtd4qCAVEJSoWqbpTG7GkUOwXVGHyAdPoLjuwelVmASIZnme2cH29h24G9y86PBMdsqTTUrfdiKdbo/BxhvKF54zcKmKBPhim29POuQgIzEHXMEk5s5dZBKMdnAbbS0/yLk8cDXXBZRIYrOFx6R8PNIwiJhBM/KDJeoOxd+afqDXpUkWv18Xx+geXTaZ78HZgJ6BpCsq+tMiZYiMELm72dcCZbkaYbfXX5vsFMn67EBwA22FewDy7N2Hi+dsiniV6kVhESoLiQ0GZNwZhAjVw2H5MABvoiXK6GI6I8GHjcctmH9skoDC7KMaCcGujr0RfoaF4hwqO5kUbxJUTPCu62eld2JxIxJcQztLS2LgQQ5sg4W2eeO+57ReUmMhFXxMabTzUYXsSGIZk7juI41XkfpEdpWVevGaXl8rxF9KbqHjFhI3+3xFCmfaq8gd34mgCCALnliy1ldP7viFNX7YhcEIcl2VAS3h5Wg+JItKr321HA1+IfJryvFRfZhJWIybtzFXsZiFtTSJ2TGLZlpb8XfGMHQwDa6mBWTRV4t1i5OGlBFhv1sTKXRThjIEaEnyvYfEUC6Y+BiXdkI2GkCfil1KfiLPQs5/ooPPnxo60/AVrMBIGevIfrXMOGGIE4auBlgvv1vgMLAgt1EHqgMuAA6X/qdK4AWt1T3Ha2NVJ/bbdA8uDRGISlxsNnBfBssC5z8xuoDUFQ2UYUTm1WNDfM/Z88JVrmGsck9h1YLr8iYaFtcVuzl5qz0tXHD/aPqixsPl1supSubfukrfU0n+OHX3/1Tx2krzZ6w0HivjFub58gcT3lQHqf27BI+++bUBgK28i1Wdfq+9JNR4jca/q3JVzbl892DTIeoH3heopipP81/X36X45tzX3gCoDurTKfvlIftHDsyvnIxHvlgGKBx8s1cvPgceR69v0eIzhJmAv3CVaii1S9CMul/ToCPoNUZZwnOsNlRto5kUtLmTCZ4jJt/CjNcpVcjMaCzL4FJiNKUj4wZCiUM7LhPgR48fypk5FTIH+DHf8LstqMOkn9eYcTUVHfYB+m0VgQWx18YDNHDtF+2b7hFkzBkmHDsqkxDAcJoWCn8EBMQuUsYh1R/J1FjaqHALiu/anAqaIHl1V1ldsQSgCh3qOk1qTyc+/GsJ+chckI/WPzQA09cib6nIuUgoiZCu2U49xhuqQDgTCb2MBquhwNPtyxlOji/WOAIz5cK0o810299kt5EWmCxjdqcDURtSGwfj2PJCL1xj7t6gYM2fg1kNwrvlw5L/+i+9+HTElm07w71KlLtwLaRr1a+C1VYdKsIMm3m4dHeHO1nYuy5wGIogbpNcXS/bUvwGLN2OFlWoXwXupPhHKOGFewHXb5msPxvCbtnd4XbJHqSt7zecneJ+YTD2v2GTuk0Yw29hEP8Ogo/wL8Cf33FhBEQ0fheUW5pA4/iWYHETVvIfUM3F4j+V7zkq
|
||||
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 'Create Connector Rule' (create-connector-rule)"
|
||||
---
|
||||
|
||||
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"}>Create Connector Rule</h1>
|
||||
|
||||
<MethodEndpoint method={"post"} path={"/connector-rules"}></MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Creates a new connector rule.
|
||||
A token with ORG_ADMIN authority is required to call this API.
|
||||
|
||||
## 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 style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
||||
|
||||
The connector rule to create
|
||||
|
||||
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 128 characters`"} schema={{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`BuildMap`, `ConnectorAfterCreate`, `ConnectorAfterDelete`, `ConnectorAfterModify`, `ConnectorBeforeCreate`, `ConnectorBeforeDelete`, `ConnectorBeforeModify`, `JDBCBuildMap`, `JDBCOperationProvisioning`, `JDBCProvision`, `PeopleSoftHRMSBuildMap`, `PeopleSoftHRMSOperationProvisioning`, `PeopleSoftHRMSProvision`, `RACFPermissionCustomization`, `SAPBuildMap`, `SapHrManagerRule`, `SapHrOperationProvisioning`, `SapHrProvision`, `SuccessFactorsOperationProvisioning`, `WebServiceAfterOperationRule`, `WebServiceBeforeOperationRule`]"} schema={{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
The rule's function signature. Describes the rule's input arguments and output (if any)
|
||||
|
||||
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>input</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>output</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={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>sourceCode</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"}}>
|
||||
|
||||
SourceCode
|
||||
|
||||
</div><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the version of the code","example":"1.0"}}></SchemaItem><SchemaItem collapsible={false} name={"script"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
|
||||
|
||||
The created connector rule
|
||||
|
||||
</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={"name"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** `non-empty` and `<= 128 characters`"} schema={{"type":"string","description":"the name of the rule","example":"WebServiceBeforeOperationRule","minLength":1,"maxLength":128}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"a description of the rule's purpose","example":"This rule does that"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`BuildMap`, `ConnectorAfterCreate`, `ConnectorAfterDelete`, `ConnectorAfterModify`, `ConnectorBeforeCreate`, `ConnectorBeforeDelete`, `ConnectorBeforeModify`, `JDBCBuildMap`, `JDBCOperationProvisioning`, `JDBCProvision`, `PeopleSoftHRMSBuildMap`, `PeopleSoftHRMSOperationProvisioning`, `PeopleSoftHRMSProvision`, `RACFPermissionCustomization`, `SAPBuildMap`, `SapHrManagerRule`, `SapHrOperationProvisioning`, `SapHrProvision`, `SuccessFactorsOperationProvisioning`, `WebServiceAfterOperationRule`, `WebServiceBeforeOperationRule`]"} schema={{"type":"string","enum":["BuildMap","ConnectorAfterCreate","ConnectorAfterDelete","ConnectorAfterModify","ConnectorBeforeCreate","ConnectorBeforeDelete","ConnectorBeforeModify","JDBCBuildMap","JDBCOperationProvisioning","JDBCProvision","PeopleSoftHRMSBuildMap","PeopleSoftHRMSOperationProvisioning","PeopleSoftHRMSProvision","RACFPermissionCustomization","SAPBuildMap","SapHrManagerRule","SapHrOperationProvisioning","SapHrProvision","SuccessFactorsOperationProvisioning","WebServiceAfterOperationRule","WebServiceBeforeOperationRule"],"description":"the type of rule","example":"BuildMap"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
The rule's function signature. Describes the rule's input arguments and output (if any)
|
||||
|
||||
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>input</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>output</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={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the argument","example":"firstName"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the description of the argument","example":"the first name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"the programmatic type of the argument","example":"String"}}></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"}>sourceCode</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"}}>
|
||||
|
||||
SourceCode
|
||||
|
||||
</div><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the version of the code","example":"1.0"}}></SchemaItem><SchemaItem collapsible={false} name={"script"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The code","example":"return \"Mr. \" + firstName;"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","nullable":true,"description":"a map of string to objects","example":{}}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the rule","example":"8113d48c0b914f17b4c6072d4dcb9dfe"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"an ISO 8601 UTC timestamp when this rule was created","example":"021-07-22T15:59:23Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"an ISO 8601 UTC timestamp when this rule was last modified","example":"021-07-22T15:59:23Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"name\": \"WebServiceBeforeOperationRule\",\n \"description\": \"This rule does that\",\n \"type\": \"BuildMap\",\n \"signature\": {\n \"input\": [\n {\n \"name\": \"firstName\",\n \"description\": \"the first name of the identity\",\n \"type\": \"String\"\n }\n ],\n \"output\": {\n \"name\": \"firstName\",\n \"description\": \"the first name of the identity\",\n \"type\": \"String\"\n }\n },\n \"sourceCode\": {\n \"version\": \"1.0\",\n \"script\": \"return \\\"Mr. \\\" + firstName;\"\n },\n \"attributes\": {},\n \"id\": \"8113d48c0b914f17b4c6072d4dcb9dfe\",\n \"created\": \"021-07-22T15:59:23Z\",\n \"modified\": \"021-07-22T15:59:23Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
||||
|
||||
Client Error - Returned if the request body is invalid.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
||||
|
||||
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
||||
|
||||
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
||||
|
||||
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
||||
|
||||
Internal Server Error - Returned if there is an unexpected error.
|
||||
|
||||
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Generic localized reason for error
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
||||
|
||||
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
||||
|
||||
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
|
||||
Reference in New Issue
Block a user