mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
93 lines
41 KiB
Plaintext
93 lines
41 KiB
Plaintext
---
|
|
id: list-complete-workflow-library
|
|
sidebar_label: List Complete Workflow Library
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tT3DgW/isq78Mkqe4GGhIWXrYIIVNMkYHlsnkgVEVtq7uV2JJHsgO9FP99v3Mku2+QMElqd5JtHii3LR2du74jH98mtlROVtqawyzZTXLtq31blLmq1FvrPg5ze32kB066SdJJKjnyye5l0jzxyVUnyZRPnS6JBAicj7UXRMULmeeicno0Us53hExpBF2YTIRFrfNCG1GNFWY0a6ibSjkj81c2xVq3C+T3skzTpcxFZtO6UKZi5sXQOnHdstVJapdj+LiqSr+7tjY3tuelzkurTdVLbbHmpfRrY5WXa+389qrrK1X63rgq8uSuk5TSyQKacaSF20QTR3/Uivk2eMIKLHSVLGrljbwRpi4Gygk7FE75OoeCKovLqnam986cKSUu/7Up9k4OxVkFHUmXiX2b54r1Jk7apa+etFKpTyonVS5IpDOzJku95iOdbtrS6U5FeMo6K6xTMAIui6Ac8O7UH7V2Cv4wlLlXZBNJLpHs9p+vdxKfjlUhyTbVpCSZsa6CkTEzkAm3Nvu4UWiji7pIdjGvkDfhmqlkaiihBf51d9e5X5t2OPRqWZ3HfBtsQ4PkPcMarha0KvCgJy58De+bCF+qVA+1ysS1rsbiGVvnGSm+lCNtZKUw39l6NGY60TA/jDm+wRit+qF8BLFXae10NWG/vvDK7VvQuan26mpMEe/L3SYmdp2SWXJFs6CvEjGtOFD76+vL8XqETEAu30wWHFDgJSX6pqIZsixznbK4ax88TbtdFks6J8kxdKUKXk6ayfGQ2a10Rcpos5LYY91Svgpz7eAD1J2Qky2NPQ8J6nGDj2PaWh59dUd/nWTrPiXs5xqiigPnYOGuOOWYh0/qYfQ6eD3UNLDZRGhKiZ9krrPeV2gpsoNM5cgRK61iDq3gkfs2UzNjPXKzGS3F1mttVHfkpCYOFbOcYqIAxU86w4zgo4EkmZZE4HG9ZMY1SRO9DfFSZpA3yLcfhYGaKifTj6BFe86XGLowGvNFM0XojCPlgWXVtpKDF+s7/a3hiy0p+3/f2th+PtgZys3N9Z3nOzu0eqG8l6OgmgX3ml/6V2WU06nIbQqL/BsKge/7uNvw4rMe+XkbMI1H6P+cdkMe24oZ+RUUkNg/xcv9E7G1LXJpRjXfl6MFJZjuxRllUeRFOaBblasVJA+Ej+Hz2tzHijKUHi6TVwev9y6OznHn9OCfFwdnuCJaS7v9noG3ZuSWlne2MYKkmgpwLT3yMeU6lfXEs0j1GQSSxs8O1OGXnyA9FCLmJsyIq98zY5a0GDpbzIVSGrKXeKJ7qtcRA7qHXJiOxUB6TLABdTzbS1NVVt2jqMlnYozcptzTnpgBGohGEMX8CQgJmWUUuiZuPAhlxZuLrSthbKVTNW+LqSrnrdFp08vRrFEoOMD5l/0ESQ57HPvEXBS23hJZjPYBz0Fz89ydzyiNVToBSEL6THn7TK1z0LAYQDYNwBLTEZnLI/GYZlybsSgFNmJxunsTmHlVWX6Wyto/Iu5OcqSfLovWPvikYvAxbgrZiK3R4sGQkSIk4MlxVGuuJvAFIEGerWJ3Fbur2H1k7C4+PI3QLz5l6LOxDH0ujASCtI43zyXo49h7jBXNoFDLBUN2BBQSIdJvb88R2B+VofHqpiQ4/B3xUdjKl4vN1h7h/oDgR2usOVsQg6zHWI0iE6lsl/mecsyKCqraXF7ttXUDDQc190BEZE0nJrYWEipztTHEiUQxnVnlzS+VGEvkR4mI8D5kQFrVZN1QhayQ5ApJrnaj1W700+xGKyS5it1V7P6YsftZJNlyxdEScZKvi4JeDrCnxeckrRQYIJpDSNGGHJtqEa0QMdFirGQeOSSD/sZgY7idqq1MbmUvNneG/fRFXz7f3tjeGGz1t5PZvf5yGsdtkM3H1Iy9gx1ZxQBxn4DjagPn8pW12fzxH9Tr1JDSGqWeFjdD573mgJGwY39nGTueWyveSDNpEJKfw5BmqiPKaRhb0FjXjMUAKUbIi0YgVWnwRa6kCwUqjs7I+dicgpekAF036e4NK4gSAqVxsnYVbdK8BoecCXJLqNnCsTSEVEPCfKDACHaE7Pwd0Wk00TcheXFKEh+RxOLgJlWKAr1F7s/vO989NOGVlTgLBn7goDdUO9LAAVAQhJzV4s4VPl/h89Uev9rjf449foXPV7G7it0fM3b/BD6PaOhhfI4Bj8bnGNtbFy2Wes3tCf9tmM6hEjlg9xY2TWvHx80NBmdcAVcihkbcnVJK6pJIpm1D03amgPkDN/M9SbcwEoxz15Ol7iF3wU7VxNhr7hkZQDP3JB3qDggBRgO4OyUs0GO1Ok2eG9IcEw9Kjp0eSduW8lnK1HpD1pvYGomNyXQEvDx6Ed8GiyVKiF88j+6x1yzJB7kuXH737bIEQg/Icp/6PrsaxgtwuiAiiTDTB3NGeDusvtQNM91DqEbrL3cn0bC+eKmkQzEQXls8+e3t+VMxIpTJUV57ArhKU1mAODmBi3AW22uO8GkSbyzT7qS9uZckFDWCnK0nYrvSYVTC70jvp8jHrFKapDgF0KzHNyvJuXkPNCe9M13xSrvQy+R5TBSRqztxWTZyyRm5vpaJvzXUuoFal6n5pwtcBNVepqHpJkXoEgmZe9bWVy8e6HVn6FHthDtEdZEH0kTkY/7VVtpY7av5mKPXJXrzfLwzb8caW+j8NBEylvDYAfNMHIp0bK1X/xCCXIfC4HJUI4q+mq1rWrTLEdHtr8+w1A1LdnUXgJD5O0JgmOBMckAbMuMRC6hmshCS79myiPn33C36fk5mvn2JfZNGZjb9Ex14CzzTgl1asBtygI/8h22JHIu66LihFEEfHGB/an/OBJHRmbwXaN2b1Zn8Gs+hrSEFq0zFl7vhx+40wcUrwQ9odDsGaZjwdPuyj/psIy3am+aU1ZwELGpwmd/cYktc0Fvgtz2Jom3yryYvSbw3PTA5Nvnke2fpBzLJXyfv/o8y3irT/IyZJiJccjdeNpYCs07+MuK15QM8OmEeK/zHU45VBtMoVUL/NaGYWUJlLivyao7qdKwVl/6lkhVhvw55li04ElGlU/ijwGNCI4cxCFsPTCoHOgc9PpxuVpYcMAFYkl3pt6+5/qC10jFKSdUTb1GNmRRmoUqM2ivw7IONJdkZLHNChhWvGmMDdBVFbbAaxWVdCAmX+oJHZNqndUhcKMyManRhGfq1s5ooJlcjEXpck7jCHw/pVBkF64zhv7AW7N60WEP1ZMXYTj8V5FTl7Jn3fCrxBdrwti59LUG1ILIuAJiaWeHN4fkSRRAzHnKh5rZutBYn+TUaCyJUHgX32ext9Na7XC7QxxbWV6heZ4hzM3nzdYpou7Kn36fMeePt9Ez9279KiXsJFQFrJZ1ZEYd1KEpC9XeZLFV/qCfGEIKe3d7SkQaVQ3d0O3zmQDUh1Eq+Pm3uf1CGH+sbknsV9lHRIUHziUw8Bki41/7xevj/+vjjM3psP46ZKvJqWjnDu64wNByVsauFWeEwbWbW0usmotIecPx6QAEtH4BU8YKWurv7D39lGSo=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'List Complete Workflow Library' (list-complete-workflow-library)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>List Complete Workflow Library</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/workflow-library"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This lists all triggers, actions, and operators in the library
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of workflow steps
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"Workflow Action"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action ID. This is a static namespaced ID for the action","example":"sp:create-campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action Name","example":"Create Certification Campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action type","example":"ACTION"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action Description","example":"Generates a certification campaign."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
One or more inputs that the action accepts
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"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={"isDynamicSchema"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"outputSchema"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Defines the output schema, if any, that this action produces.","example":{"definitions":{},"properties":{"autoRevokeAllowed":{"$id":"#sp:create-campaign/autoRevokeAllowed","default":true,"examples":[false],"title":"autoRevokeAllowed","type":"boolean"},"deadline":{"$id":"#sp:create-campaign/deadline","default":"","examples":["2020-12-25T06:00:00.468Z"],"format":"date-time","pattern":"^.*$","title":"deadline","type":"string"},"description":{"$id":"#sp:create-campaign/description","default":"","examples":["A review of everyone's access by their manager."],"pattern":"^.*$","title":"description","type":"string"},"emailNotificationEnabled":{"$id":"#sp:create-campaign/emailNotificationEnabled","default":true,"examples":[false],"title":"emailNotificationEnabled","type":"boolean"},"filter":{"$id":"#sp:create-campaign/filter","properties":{"id":{"$id":"#sp:create-campaign/filter/id","default":"","examples":["e0adaae69852e8fe8b8a3d48e5ce757c"],"pattern":"^.*$","title":"id","type":"string"},"type":{"$id":"#sp:create-campaign/filter/type","default":"","examples":["CAMPAIGN_FILTER"],"pattern":"^.*$","title":"type","type":"string"}},"title":"filter","type":"object"},"id":{"$id":"#sp:create-campaign/id","default":"","examples":["2c918086719eec070171a7e3355a360a"],"pattern":"^.*$","title":"id","type":"string"},"name":{"$id":"#sp:create-campaign/name","default":"","examples":["Manager Review"],"pattern":"^.*$","title":"name","type":"string"},"recommendationsEnabled":{"$id":"#sp:create-campaign/recommendationsEnabled","default":true,"examples":[false],"title":"recommendationEnabled","type":"boolean"},"type":{"$id":"#sp:create-campaign/type","default":"","examples":["MANAGER"],"pattern":"^.*$","title":"type","type":"string"}},"title":"sp:create-campaign","type":"object"}}}></SchemaItem></TabItem><TabItem label={"Workflow Trigger"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger ID. This is a static namespaced ID for the trigger.","example":"idn:identity-attributes-changed"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`EVENT`, `SCHEDULED`, `EXTERNAL`]"} schema={{"description":"Trigger type","enum":["EVENT","SCHEDULED","EXTERNAL"],"example":"EVENT"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger Name","example":"Identity Attributes Changed"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger Description","example":"One or more identity attributes changed."}}></SchemaItem><SchemaItem collapsible={false} name={"isDynamicSchema"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"inputExample"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Example trigger payload if applicable","nullable":true,"externalDocs":{"description":"List of triggers and their input schemas","url":"https://developer.sailpoint.com/idn/docs/event-triggers/available"},"example":{"changes":[{"attribute":"department","newValue":"marketing","oldValue":"sales"},{"attribute":"manager","newValue":{"id":"ee769173319b41d19ccec6c235423236c","name":"mean.guy","type":"IDENTITY"},"oldValue":{"id":"ee769173319b41d19ccec6c235423237b","name":"nice.guy","type":"IDENTITY"}},{"attribute":"email","newValue":"john.doe@gmail.com","oldValue":"john.doe@hotmail.com"}],"identity":{"id":"ee769173319b41d19ccec6cea52f237b","name":"john.doe","type":"IDENTITY"}}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
One or more inputs that the trigger accepts
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></TabItem><TabItem label={"Workflow Operator"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operator ID.","example":"sp:compare-boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operator friendly name","example":"Compare Boolean Values"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Operator type","type":"string","example":"OPERATOR"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the operator","example":"Compare two boolean values and decide what happens based on the result."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
One or more inputs that the operator accepts
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {},\n {},\n {}\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |