mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
134 lines
48 KiB
Plaintext
134 lines
48 KiB
Plaintext
---
|
|
id: update-campaign
|
|
sidebar_label: Update a Campaign
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtz2zYS/1dwvA9Ncpasl6XY9+FGlZVWHcfKyfJl5uzMBSJBCS1F6ADSjs7j//12F+BLkl9pp6/RtBOLJLBYLPbx2yWBO0+thOaJVPEo8E68dBXwRAz4csXlPPYOvITPjXdy5Q2ETmQofWrKsgbG+3TgBcL4Wq7wAVDoR5G6NYwIyXjOZBzIGxmkPGKhFFFgGPTnzHcUWGqwVbIQ7OqHi/E5+8ATf/Hp1SJJVubk8DBRKjJ1KZKwrvT8cJEso0Md+t3jRus1MwmPA66DOjBqhJ9qmayB2Tvv0gg9UHEiviT9NFngBGQQn2SDnthpQq/KXS144H26hymtuOZLkQhtiJzEia04EDrwYngAVzLAMf2FWHLv5M5L1iu8axINs/HuDzwt/ptKLUCmiU7FppCmMN3RKVMhTTyXRSKWqwgYYzOBQlmqAEQuaHriCzSKcIyWf9x823h71GvO/NAP3zaavabfaovOrNNqNUPfwwng8MIk36pgjew9zk2fRdIkyE2xKiQgliuHYdz3lQ5ordTPXa7rGAXg1CFZ8AQGjmHSbIXURMBg3qHQbMYNXIC+4HjQO0nNpsyA1nU8si3eXEz73w1P37imB3QzVKiQyLcbrzrUyXX8huGa4t+SWPBSC18tlyIOrAiGMZ9FIrANeRDJmDqBBsjoXBXWUWrH00RNxI36SZBZ4M2C2/5gOvrX8OXcFoODXvio5XGCi8xXq8ixcPijUXGNOv0Nf+LjLWXlWvM12gConSndV7MfhZ9421qCC07rzcaZXjBugJ8QuAnYbM2uJu8GDBeb1dhL1cMrG80V+CXvwNoc2qNGTUykID7h0ZbJ7bKwXHtRZVGIQodKLwWarojTJQ7Dg4AGXqobQT/AAH385W74aoUySsCYkJHCDLOW947LJznqM/vACUZJWDgNOrbSwsAKZl4w4XouElzwBbINyy8iAUqYuElwsAw/seJOypOsOInD8tjA4g2PUkGyi8U4JKe2yW3R+Vzclk0Bpy+TqOLf8u44i7nQ5f7tRqPokT0vdcn1K2uT38hJgDInMNQsTeyKO6e7WshIrrz7+xK1TIszYvb6fisuoUKQFJwcU3QtoA5VIR6wTAfp2TXqx7UHqxDAb7fkcF34xUcFB3zmfP0AZkjWkNsOPc47X1m9LmmgVSvvkCafLyFMRBrrHdgCrG8mROaug7+QmImM09tQq2WJRkaywuQnlCeMa1YwHyvvVqOBf6oSHEEkB/ciDInsQ386+L5kYib1fSECERyQtLRIUh2biq/+xrAYJJSrPHWsP+7EdnquLQ26iOSSlVBL2ZG4qW8oNBLaciwQ1HeYMcKCcRytdwfPUbAZkjajdaN3PGv1GrzV7fIuRGv41esdh/6s0Wj00Ditdm+Ke1pGBtikzkY4EKy+nT+DXwBUKHDzHDscMLMSvkS4Bb4OzAgdC0lVmL8zIwTx+vkwI13LOprDOxncH85FjEsqPjMIfCv0UixQfrrM1ovsIhAJBD1TzyS504285zEH0y/W5X5Dds/x4bkESo9+n4IoJj68EXoNjha0XSDAIX+jxY0Ut7nflpotrXysWGxI3yUTyz3cQROvJXJLm6uCAiMD1AKMEI8Z4Tpj5DcI1S1TQHvAkrRAJEzBVOkKAB6sF0YdP5E32LQCtRjKfa1Sluh1pVUJzt9KiFs8H5dsQwV8DbSz8VbcJAdE51ZGEaIsIW+QSKfRYEJrhVHROqMN5NtoNWqNdq15NG02Thrwf7PeOer+GyVopfYcjcIWZaxbZwOVgjMFgUC6AGsNa1SRTL0EF973zwFiTuDOxfhyMhj+Z/zx3F4O+5PB9/BjMj4b/mcwfv9hfDGajsbnVdSQ9UfP/wBuLM1iBnBJ8HhrGralsdCTxSUaLqJJU/ZGANB4GoEKhTwyosQOXQMrWzD1GTy4PA+7om5D368bezfIfoEQRv3R9sh11odwtErA+sBnM3EDQVJaN43twe0HKTiOUHCr+5hXhORX8DFcYvTC3COkTnFO2LDMLwBCgOBqh80TN9Jo6QIloznWGWodBJHI4Q9qQ0TJLbiRZD40MKvB55AcCoSi59ta+aBwcdIgW5tZvMzRov9ItUbAabvXd4TAzBw+DM9PR+ffof5T6gU/Bv3zwfDM3qQMpz8tXQyxBRjH2dDddRfUdTiZjNGW0JKg6WnVdFz/e4QLwB+KO7h4yQQ3em1lkgxnyMp2XVp1l4ddxgUZ0LG4coP5lSJJ7hMV0pWxH6XAVbWHDBD6I/5gr4Cau1yjGqSVdiGTCeG9WFEqnsaJraTEaIILpSVGJXCjRqXaF6/LTmswnkyGZ30r5Mvz0mVFwKX7KGRY80Q8CxA9I0INLDWGDx/HS87HN9rTVuukeXTSbNe7zab18SrhUaUQVV76IhPJ+YFb7dbuIICkGMhnBraGwaBC1Vpa2Z3ssoGM52ajQUpJQVcEvwyDJdYywj+TSfTzEVAwO0oAD9WDKBobAvS3XMew/K5es+AYsX2AQ6m1hR1jP1hXqILuCPxdtEvNMvXN3MLH/uQc/ozO3423y46nAsKgS02IYqZlS2EMwKwqQCOKIJBI+TyS/9taqidLIxtTQDLPhB+2be7XHXsMS5WQObFvBx9Yp8ciHs9Tus/nVRAk4trlBdYh0yjCEJE7e0t4rOVc7sTWmThPh+/6l2dThCrDf14OL+AX0tou5MZZIFOkhwt1a6VrJ3ALvsiIiGoRdfbGUX0DE+Iu7XMNpb0yawPCZC5kQQ83+o4eZdJZkBXMlTSZb+u67JWsi/oBOGW4t6SqVKVc+MYCgNqZk+QbtgD9FPo1uO0gkDjJLCIb6L+m2kqwBf4I0Ko0IZTlbwDSQpTV1SgS07PyoqALA86fUSryE6yX0zSdGltcnGmLYzEDGoGTXJW7aUloJNI1ZC4A2aElxCMKLgCBZjA3mRjmcnBcLgO4Ms7ayRhkJMHAy8WMIXLz3jJzmiiqyOQPs3yvj94GHxVlDrIWlxfiz7wshZl3Vtnu9prHQviNHla2eU+020dHvN1t8KL6nqWWE0qqdjgwm22RC3PJ2DdUwgaWtxIwi6SyBMxGoGar1jqaNrqUZTTqzVb730WuWyQBGcAqwM3DqN5htB1Y2z15CAlbpAxCvBBc+4ttufUEiKndFO1w9rZz5IczcfS22WzNeKfbawvRKeRmKZQrJVXBbTxnozhUW9Jp1Rq9Wqs7heDcaZ10OiXJ5FnQrywYwjxsfBu/VK06IKZCPP1T5kg9Q7GgIYMOFm+9WIc20sdcXjmOflhe1sN8pbh2oecK8gNxTiDhGgDqUEZmhZqqRNuzlmiBkrWa4i1IsDfrBt3jdtBp+p1Gt9UuSRRJsRKth1UvF22AlROwUc40dla4qM8Qb6f7tiTerSz811VJ6/Q6u6qog0iimyUPymqgaEX+V45yMxVQFpC7359RJa2CFVuyGqjgGYDlHci7Ntec3u/YEORDR8yfb2Rg31FCjLQkK6GqGoo6qP/sWx7AfO38Bm4yGDc0938CWqOdyUaVoctY/hdL+K4LJEw5ktoxrOgJPus2jludsNvhvAXK2juaHYe83W4cHx0f4+gupD6Nir/DvF/6zGFGgTVublzJhQbfA8Y9YNwDxmcCRvBnPDXPsLsPEbifGk0tf3AjnPFRdd16I1qNbJmcR3KfKlBn1ypfrszw7bu0ve3ubXdvuy9P9ujhxL2ucU8J+jS3oc9l7EqVGDy3oI8tw2N50zWyVVS7kAf0/shK54ePUzDsn7Cib5j4ssIXvb8gPrKhfIv5fr4e9v4s+2AjC/3FWiCDJEf3SgY8kQhOiO+CY69Aie3t0d4pPZOgoPEOiAheU9PrMw4i02kc04tNcwDIWZj4m6I4h8kueUAcNQ5q9BJzjyT3SHIfjfbR6M8TjfZIcm+7e9v9Y9ruo0iy+trA4SSTLpdcr62muef2wy9okH84xHKTyyuXZbSCxFiOsbwqcvBmreasGfZ80Ql4J+i2j8OW323xo16z15x1Wj2vHOuvCjvOjaxqU6X1tutIIgYQh995pDEol0mUCqrlPxCvFiG6NfrSKsPNIPO6/WLTYcfONnY8VwnMDQgDdtQPlBcvJ2dIH4Ym8ig3W/hGo7Uf1dF7XoSUqMMgaWmSPXTcQ8d9+NmHnz9N+NlDx73t7m33j2m7L4KOnaegY+cF0LHDEGKFCLF+S+gYAO5AaBbCouAn+O6r3er2mtzs3b6yDOhVUGTreMf2E6XYex6vM7BkKpXIuBAXujdou8S2OmsrcY/vXOJn1+C1pLKbZPDjT8Ck+Gl0JJeS7BgnBHT1utYPcUOctZlM3/JR8s9n0SlEym5DveUSNzKECP+AAtVB5+Cof8EaZ/b54M+pB7MJzvgMZ8yGX+wuKZbXf49277UCWaC7uLBr/cDnArZmzmNII8SXlXVfOQTdQ/U9VN+H+324/3OE+z1U39vu3nb/mLb7Aqju0NDDUB0aPBuqQ9t6g+VY6h1tlvu1ETuZiuOA1Jspn7B6UGBwwhWgSsgQndrhFXv18z1otC3Zw5NuEBJablIdQZvseI07WCRYnPs6X8l6tpcsVrd1Xy0Pb9o7XA5+YWrNy22JxJSh/2Hkcow6iVZL2mlJqkkDWEG7vYeeAYHTpwWP0scPgnEF1/jdtCVzgHtxnSbRbdzqBGkEnhOA+93dQQ8bc4S5Xero/qn5/Kv92DwskQfmsUt8j44F7RlwuTE9ZP9TcTDRBeJtO/rW8URFDMFK//aOsDE2a7FvBde0QRs/fnn1w8fp69JuVHuQkpCYFoCdfAAVIS/Wzz4EwU4UWLRK5wtivF/51AathoURTJhdxxdCsKuRE8I5uPcJ+GMSKXYS5AKwV3G4S4DbrjDy1QtJouLJID4ECR3ySr/XFOUoHZCx3RCHW/uv4xo7leh8aI8btnFTpOyOXa2yefHSvL6Wib9m1GqWWo2omdcbXFjRXvn2020fTBdJ8MiQtL56cEuvVqKHuRPcQaqbPKAkHB/VD6T8bNW+mo8KvRrSq/JxHX9cSAih1W7MeixmFrR9fsT8hVJG/IMxVB00g6t5Clb01Wzd4qA1sohaq1FiqWaHrMkaAELi7wwMI7bKxGcYkAmPKFsaIZP8TCsLNv+ZdjN+rsyZbl/hAQjQMlC++WqeccAaDlizPsA4/t05Ea/pzCacA/kBqwCDYv3JEzhGSz7P0trp1Yn8IfXB0OADq0TFrE7sxUnh4NwvRg+wdd4GXDDi6fyTMbhmjta9PR+gEFZWCdiU4Da/kYKQuCE3y2/+PhPD5O9tvjjjflEwwS2tv7SXfsCT/H787m/k8fae5s/oaRzCxcLjpDiXcPj0yVfVM5uyA7C2TtkCkIWqTFNyaUbZgCwS3C4NGjreBv6Fp+QFCKZDEmQPsUF8VCaDB3ygvdiTbxZSUFFhJXiCqPKATkJZko0DlEbHAqkjEZrT2QcahMEhDZQR0Kuzj5C1xT4sH2ZsdKaOYj8ql7pdwArSAXHsNFMK3ES3TGM8GwKYSJcMN+E/oTmBNH5qHRwkcLHIZqYIIua9MmunDY0gCjrVSeilGYdYfYbEtqQgT4wF+mFc6RkEiSviNgIWE5ng5kNpj06rQvunaINW1hYiWtHOfWALMsDSCO9H0y2KQCx27zvwvEHXyRxiWzwVDyZvlaFdh0yRzvJTJoEEt0T30h6FyR/cunhXVNp/s9NPXWDCjOJwhQUwnEtqMxxrTVdenkhC+xMZ4BkKC5gtPrq7w/IIplX3eBtsFHPvq09F1kRmCgtR3SD5oBxeTdwJbK/pBc/LzjrdOZms5hevS64Afv4ksEoA04FcGiZEZRxi1j5w7w1q0/WqfIjeY2dlYs5pO9sq0SPdyPfkmTsdiQetZ+7U1aWtQmiOG4nx3xPvGv6DC7WyFgCN6P6dl9X0oI0lnOGuXbDD/YAFgmb/B7jFZmY=
|
|
sidebar_class_name: "patch api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a Campaign' (update-campaign)"
|
|
---
|
|
|
|
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"}>Update a Campaign</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/campaigns/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
## 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={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the campaign template being modified.","example":"2c91808571bcfcf80171c23e4b4221fc"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
The fields that can be patched differ based on the status of the campaign.
|
|
|
|
In the *STAGED* status, the following fields can be patched:
|
|
* name
|
|
* description
|
|
* recommendationsEnabled
|
|
* deadline
|
|
* emailNotificationEnabled
|
|
* autoRevokeAllowed
|
|
|
|
In the *ACTIVE* status, the following fields can be patched:
|
|
* deadline
|
|
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value to be used for the operation, required for "add" and "replace" operations
|
|
|
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><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={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Indicates the PATCH operation succeeded, and returns the campaign's new representation.
|
|
|
|
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"description":"Id of the campaign","example":"2c9079b270a266a60170a2779fcb0007"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","type":"string","example":"Manager Campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details.","example":"Everyone needs to be reviewed by their manager"}}></SchemaItem><SchemaItem collapsible={false} name={"deadline"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.","example":"2020-03-15T10:00:01.456Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`, `ROLE_COMPOSITION`]"} schema={{"type":"string","description":"The type of campaign. Could be extended in the future.","enum":["MANAGER","SOURCE_OWNER","SEARCH","ROLE_COMPOSITION"],"example":"MANAGER"}}></SchemaItem><SchemaItem collapsible={false} name={"emailNotificationEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enables email notification for this campaign","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"autoRevokeAllowed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Allows auto revoke for this campaign","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"recommendationsEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PENDING`, `STAGED`, `CANCELING`, `ACTIVATING`, `ACTIVE`, `COMPLETING`, `COMPLETED`, `ERROR`, `ARCHIVED`]"} schema={{"type":"string","description":"The campaign's current status.","readOnly":true,"enum":["PENDING","STAGED","CANCELING","ACTIVATING","ACTIVE","COMPLETING","COMPLETED","ERROR","ARCHIVED"],"example":"ACTIVE"}}></SchemaItem><SchemaItem collapsible={false} name={"correlatedStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CORRELATED`, `UNCORRELATED`]"} schema={{"type":"string","description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","description":"Created time of the campaign","example":"2020-03-03T22:15:13.611Z"}}></SchemaItem><SchemaItem collapsible={false} name={"totalCertifications"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The total number of certifications in this campaign.","readOnly":true,"example":100}}></SchemaItem><SchemaItem collapsible={false} name={"completedCertifications"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of completed certifications in this campaign.","readOnly":true,"example":10}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>alerts</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of errors and warnings that have accumulated.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"level"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ERROR`, `WARN`, `INFO`]"} schema={{"type":"string","enum":["ERROR","WARN","INFO"],"description":"Denotes the level of the message","example":"ERROR"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>localizations</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={{"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><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 \"id\": \"2c9079b270a266a60170a2779fcb0007\",\n \"name\": \"Manager Campaign\",\n \"description\": \"Everyone needs to be reviewed by their manager\",\n \"deadline\": \"2020-03-15T10:00:01.456Z\",\n \"type\": \"MANAGER\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": true,\n \"status\": \"ACTIVE\",\n \"correlatedStatus\": \"CORRELATED\",\n \"created\": \"2020-03-03T22:15:13.611Z\",\n \"totalCertifications\": 100,\n \"completedCertifications\": 10,\n \"alerts\": [\n {\n \"level\": \"ERROR\",\n \"localizations\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Manager"} value={"Manager"}><ResponseSamples responseExample={"{\n \"id\": \"2c918086719eec070171a7e3355a360a\",\n \"name\": \"Manager Review\",\n \"description\": \"A review of everyone's access by their manager.\",\n \"deadline\": \"2020-12-25T06:00:00.123Z\",\n \"type\": \"MANAGER\",\n \"status\": \"ACTIVE\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Search"} value={"Search"}><ResponseSamples responseExample={"{\n \"id\": \"7e1a731e3fb845cfbe58112ba4673ee4\",\n \"name\": \"Search Campaign\",\n \"description\": \"Search Campaign Info\",\n \"deadline\": \"2022-07-26T15:42:44Z\",\n \"type\": \"SEARCH\",\n \"status\": \"ACTIVE\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Source Owner"} value={"Source Owner"}><ResponseSamples responseExample={"{\n \"id\": \"2c918086719eec070171a7e3355a412b\",\n \"name\": \"AD Source Review\",\n \"description\": \"A review of our AD source.\",\n \"deadline\": \"2020-12-25T06:00:00.123Z\",\n \"type\": \"SOURCE_OWNER\",\n \"status\": \"STAGED\",\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"correlatedStatus\": \"CORRELATED\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"RoleComposition"} value={"RoleComposition"}><ResponseSamples responseExample={"{\n \"id\": \"3b2e2e5821e84127b6d693d41c40623b\",\n \"name\": \"Role Composition Campaign\",\n \"description\": \"A review done by a role owner.\",\n \"deadline\": \"2020-12-25T06:00:00.468Z\",\n \"type\": \"ROLE_COMPOSITION\",\n \"status\": \"ACTIVE\",\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false\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={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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> |