LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 04:19:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/beta/create-campaign-template.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

181 lines
91 KiB
Plaintext
Raw Blame History

---
id: create-campaign-template
sidebar_label: Create a Campaign Template
hide_title: true
hide_table_of_contents: true
api: eJztXetz2ziS/1dQug9JpiyZekveD7eKrcxqz7Gyfkxq13ElEAnZnEiklo9kfCn/79fdAEjwoZft3GRmWTs7Y5F4NIDuXzcajea3mr8SAY9c35s4taOaHQgeiWO+XHH31rsUy9UCftcOahG/DWtH17VjEUTu3LWpCtMFw9rNQc0RoR24K3wBLR1TS4wzW5VhujU246FwGFTXrxrQQSjsOHCje+jkW+0qFMGx70Xit2gUR3fYset4R7p8PVJNHUl6azcP1P8qEECYgIFEQSwOaoH4dyzC6LXvQLPf6KcbpK9t7MGL8BVfrRZqUIe/hjiAb7XQvhNLjn9F9ysBQ/Jnvwo7qhVGmh8glFgFOK+RK0Ks7zpGK2EUuN5toZUJzMicRXcinbAobU/8Bg8XWL1lD63+cNbqW7zV6/Ge1cS/+v3ZbNizLGtQezioeXwptvd4eeeGSR8vQoa1GuxvHP7y2UxwrISrdCs8ZBFYMk1Z+IIKh40MZW+5x29FwIrz8ZDrel/KjLc7E2jUydGZ8OHcD2jCuefFfMGWiv6UK4FuyWA7rB/xO8qEg03DUpaxBZRxpt7iXnMgULDkwIA1rFSP3GVura2WVbfadat72WoddTpHltVo9zr/QsKWvgNyuAtlb6mk/Z2p67aOrGFj2BsSdSg7TrzIkDfz/YXgXklHOUnwHKRWhMxFgQBWKEgEuwMmmAnhsaSjzBrP+SKkduc8XkTqN5DlfwVOORfz7UJ9CXxBpaVUGvx4APziEN8k7xO2M1hxHvjLbEX2xeWAh5riBiM2hzVcOAz+4HHkw3TD0BeLe7byV/GCGuIRszVv4Rqwr250J4EiDgLALxYDWjaeCDo0ljzQNAfWoNfr95y2sABoev1+r9l0Zo5otaw5LrNsvdiL8OIlgvbkZHx2Obn8Z1E9XEKN9X0n9XYGszMotb69t24YwVIphMJWAdndxfZmx1hsfbvLoKFQ46/qYcP2l7WHB0I87ixcT5zEUr/uAntCrjCsous7zIkJ4b7eufZdVjOEd34MXDODRz72CnxywKS4EssAN3lscjGtD2DZmKagwd7fgchkmVJzbGio6oNMbwTAcizAe4sFdmuyH0HKahGHsmUn6e0N4KualgOUZdUVMrJvU22yAiSONOEfJVmJVHyFgXyovWu9/1BjL6OvPvsqxOfwlSQvECHINk5QKaF6gnTrzS40UUp1swM/7sNXWS0BvRL+q7Z3QQygm+bnzl+kqgjolHLsenKBcPgL97MgFXpg6ikmIhuJiNyISNAYDY8AE6ZzMo3yROjCFwt3yYwaqbFzLUUoS6+S3ZvdUGMLYBdMl50sluHcnoHF0jeFvCgQyTxK82Si0FiOH3FzxYMI++cGQocrYbug0pVIIJOQhSfCv7BQSPb9dFgwJ8PDb67zcKhF4hMTnrPyXeQW346XwDZy+dBwcEQE0ECmRQH91ppEj7CEjBnImEE/4kSkAx9/EcG9D3LoCeEAMKC9BpLwxRVfQRRm99ixG2iTq2bAZdmclBoi6ycKcEDBIlk8quEGkwqXBH8ZhxGS5Ho0BfM4igP65QcOrBfQy+3I/YJFTb6GNmDe7/2YRcF9ppSxzyH9zFMoQtnwAWGgbd3fiofRAbVDgAHbFuF+wUY6lsVEEEBJgLcVmK6iUWpzNbuXTQvMwSOr2eh0e//apIxLlIxSvumwjjVcwo4L1prgypiZhqHT347ORj+Pz+HJxfTq/Hj8cfr+TP4cj86P/wZ/nE9Pxx+Pp2/fTS8ml5PpGaKMIROqvlbCZ366oRx7fLbOaMwpZioZMmoC9gPGplSa9YbZWMtbgnlLEUhB6+tcfPE/i9Fi4X/diQYqKQ035G2o+7i+Yfn9JQiVQ/SH+0/CZDQp9txgI9sWqwikDzCbiS+g+l0J01geYN+JATjmYFoS7wOUzOeEK/gaTYQ48FBDz6mSt6uVSxztKhue0RjR1EXxByD6whexKkONEiyontykayAWTAc5D8k2zQ9ui1y5dnJx0LgRAaSKw/2AFvFDWQmyeqNEBWpxeDc+O5mc/Yz8fwl8fQJ/HI/Ojsen8uHo+HLyy+jS+DHGEiAcp2P1VP2gquPz8ynKEkoSFD3Jio6qj2aJHyi74mKfAeZq5dV2g+EImSnXxqrbnJbrykubAR7zMg+YnfEPJZjoY7uuZy9ioCpbw3Vgol20P9hLaE39vEc2iDPl5syNaOPnIe7afuwBb0MnQBaI4J0fuKiVAEZDPw5s8coErePp+fn4dCQn+erM+JmZYOP55r3/TlvlMoeYIy38jfaS3le3cV/d7B412w3Yd0mM9yO+yPjgzKUHBS1uaYuS0AOP2q1yJYBNMZifmdrEZlqVkmbCSZkMaJqblkVMqfYiz0OgQZpu+IlEIs4voAWTJB4E/L4I7WCih2RNkTYOaWfylQceLD/uczhyImps2Mcs5Ua9rG8XUDEs2zpkje4F4F3pZlSzr4aF96PzM/jP5OzNtLilPhGgBkVIjEUtai5bijAEMytroFGLMCEL3+YL938LS6XnZdchYDM7mh+ybILrijyG3t4DsIFeH79jnT5bcO82puf8NmsECa9+dQFPvHixQBWRgL1seBq4t26pba2n82T8ZnR1eommyvgfV+ML+AvbKswowpFUZD7x4Z3/Vc6uHABuT0OxgOlAJPxJtfoTDIh7oVnQlb/C+xAmkymVBTVU7yU1zKa1kkVNSf5sZkvXOHvpNkTjAEAZnoE02Xepax2L/yQNgPqpmsmf2B3wpwheAWw7jouD1Bo5hPr3iO7cKRh/ZND6cURWlp0zSNOpzK5GujE9NRcFIQwo384nIztCnywNU7GxtIs1tygStaHhqJnLuXqNSaMpvYedi619bKRcwASawdjcKGTqPACXKwS70tPlXA/myAUBR7eOHtYYqXkriTmJfOnzye/cR4g2+OrhYJsAbfLnPkLbvFXN7atuWtZRs9Xo9aWTuczMqMyKJ5oVc3cRgQ7c6lA6AY0XLGEHGSoXIEFx4oJTw3aKSpCsbYUy6VzJbmn8oRx3lPE/L8QcRAFQ9/PjfMnY6eQE1/4rqEey4PU+M+16JtAFgQRkBdWaz8Sg17Yt+H/HHgx4uzt3+vNmX8Cfzry7x/7WcCyrmTbWa/T23Wjy89nHN5PTS9q0nl+djnOLlSvzKBd02rNx7AQg9EY+J7AIY9jeR8e09YvC88Rft3XbZzCGS8YRNYA8K5uULg77DmAf3bqBxEBsPLNjyplHesNEXD5FV7dGsYk397ez61vlUkECpFzmjzNxZYAHTBwosprsf+Jst9HIlFBWmqylHU1Z0RAZ8zBvz6jFfDBm4no7O97IFRQ8sO++1zSRO6U4Qfu7eSSZpkd6FYgQeEZJYf6wBjeqx+OLi/zmk57t68E8oV8zoU4HcrQ02MRTDic0B0MwtBAgcEJAawf3BBXyxG3lh6E7W5Dr0NgbGDivDaZD/oW7ZItkQeZC9p0cfZqEkhuG3JM7IPNkLh2rqGAP5LgS/QKjuPUB/Dzu2YLdBn68ypya6F5ovGBebN3SEJpz6ZRiJ5dTWlYp1nrFaH5+nv4yPj9D18PHn8+nV++ewjmayBdh0qPJKfmucEtinPSVn+PtqkOMvicnOe+nPJLs9gZ2tzW08UhyYNu8Nx9adrPdbO8T+5DpiM4WMl29hyVz+ZLBfzEchMSdOHK3tkMbJj7Z4WTX0nAU4/Ijs5hcnLjDpJdcyQGusFEoswMFI1TZBqV10fwiHPhEPz8hi37S/ApA+ynxhgMmbZYYSUtOboymdthXOy7Z3Bq4zTH5GrhLhEAPIUM3DkSNKTeE9Si/5L9N5MumZVn7ov5BTc73MYhqFHDX28GX8CYOYC3Qo+/EttqfS/7IB/zAqonfcAYQA00DlnaA65bvleQGx8cNmmQKmjxJadlsrNmCbDvNJ1k+Hb+F/yY64uO78ykYSmPl9l9/0D8iarI+CKM94qOS/UWZupQha34gteTp+BgMa+Mcbp3nolTT4+Ekd1q8b3Fb9J0uHU7a81bL5kPLalq05rrDTZMzOj2lMxBJTnEertDoBhZ3tPEGZrIgvljPD+kxv+QdpSS1XwAmjEklkpNaTcTDQ/YcmGg3hnOT7lhHObYuikppYzg7AVipYMWCfiaXwn7m0HSl3BCw+Z67t7GOD5CBWzRebJ9cgKqDdO9YVHGVDq90+EYdjsy0i6JK+FIrKqy4VUcBPvlKUamOPtG6JlpKOtkAzP6CQOYJlxAA+QCeHRAvyY54kG5jdt627ARmgVgKx0X53zEQDs/MTVcEHnbKJigkjYefU6cEBxv91iOka7DzQjEclTpVIdkRHKwLdXTqgDCGJPuesmbyuzeSIlICC3HLFywdSbJpeqG59UUapmff+aEwPEDaVODsHJFl5Czp3J9Ng1v5Y3ep2x7ndkqUnqeUXkoMfpp8ST+LhCLdckHMNrPCXmLmGa6NbI9rT1tq6eSu00Mw2pvdzepEItUWUtqiIJBSd+YCRX2MtBSp5H5f6SxYzP+gMT1xr7xW8T191yyHsW3DTEtoqHZ2Ylr+uUXN4spN4koK38M0ToPVHffGHpkb5K7a4whOO3dyeCDNXnTag8HCPnz4UPOpFyaMbvAxe2k+SY4zuHRcY5gNGdwyWMthowhWZxZH4hX5ocVyBaBBtLhJZHKGDuU8Lum9wc5iIxqC6gHrKEaLvc+e/9Urq1gY68vMLzzL0Dg6E8ADiv91MAe+d3ERl+TlefWEs8n9wojlUu2NRNvwVboMyzcXWfGTBR/lsy2h/YIeyYiuklWSJztgJ2Pojh/cK1+ucuUu1d2SbTJvqFa5IUg8uqbrVsXaSR0Z6tjg7LmItIaA6/7px3SuoiqnLWqDNWnoQKnfOulV4zEU9Pz0QYO9vtdnCgdZCnHXWU6laW/C/ujjyfh4cjGZnl3Qyesv0/8Zf5yenf4z8/xsavzMGKKZNzDxN3kEKg1z1UEcxo0JI6r3pnhmZ95aUZ2TIOjg8ZIjMFdLY2gEXyp4kqdbsdr96cipwmWTMOsb0pHE5OGBxRbSp09N4mmyjoVmfB7JLaQbpNcEnOSagrbLcGoc9qH2zQx/ftAB8WCfIOMQUjZuG1AuiTPsFcoQmNChMU6FFLNatlAJlkvWpIAKFRr6QnsoCuGg8pQiHz1PEdnZgOzdOpePi/0aLoM0prFwOFc8MkJErAnANM5FbzjotsRgLgYz9BF1BqILINft25vDGyUCl8Qcqii2dRGB6vVGwCnIyYEySp6Jc5X5pdZuM/9K5yaC6wcY08oPYG6BywyfpUQkOwAzhYAp9XqVsdk5tYHAJ/0Vj+M3GI00ZHVjMjBjX7ZTpt6eXLepd8VySSDtczLjxrMqdbaT2OK1v0piX+JQj9hLc/VevSrR/4mrklRlOjY+cxf04seSB6nW6ZDzuaRCNimvhD0O1HFvsgRr9m4nUNcM7um+y+RldMLUWHcQFCjIoELaWpkwNN+uEYaN3ewAwblg8mdl/fVH2sZp87V2TXX6Vt8RM06W6tDpQEsd0e32hrSp+W5MXIy1yYaX7Mvk51m37DPx+QZn7O9hwBR2qJssmbWFS02aNaW36xqaoxTvaZ91oE/kEp9z4rrcV+3sSpeSOVSqKNnSC5LKW+GSxlZH/jrHoRE3QCKpxKjf47OWbXXbVhP+6s17XWfudDnn5Dn4QXSB3MDpuzZk57csqygrOng7jGlR57Crv8fJrFIIVCkEqhQCVQqBKoVAlUKgSiFQpRDILG2VQqBKIVClEKhSCFQpBKoUAlUKgSqFQJVC4D/url+VQqBKIVClEKhSCFQpBKoUAlUKgSqFQJVCoEohsKMLukohUKUQqFIIVCkEquuHf6Lrh1UKgSqFQJVCoEohUDo5VQqBKoVApcN/eB1epRCoUghUKQSqFAJVCoEqhUCVQqBKIVClEKhSCOydQiC5bSZvMfadmbCHQ6czbHeG9mDYbc6cQWfeHXCr22xZtYO1d92TCBM8hWvVrUHdal02h0fN3lGn1ei1W/8y6T7CI9bvczu/2cETLPN6hAqQr4XxCu8D/xXQK8JHDW1Hhb7vUbR7svHO3yXrC7vVbXF75nRanW63M5jBbwckv90Z2LN+N52YC2j4HcWXXsjucndI9C1LIxg7mTo5KflJerYrqAmNdH6jV1Cf46w/xZEgu/Y0RVJZdoAg32zcVMsiOpRF/iqNDJKv1sblKCI2q2lZyE1m9ul5G9JQX0V6Po+DDtqTr/8wl3bTTA1ZgJj1Ra/THQrhdFudPrcHs+GAd+fCGTTnotWfpzy2PkVCHin69daAkGJ41LEaVrv7VKTYM69CBRi7AYbaD3xHvCjmgdg/v0N6+DVJJiR1pcnfu2aXyBwHKKQq+syvt3oOfwSQy59/PGO6kDUgmATR/1ExMJedI4eEw3mnObN7Q9HnndawORs6wuq1rfaw51hty0mFpyT5Rbmx1Ab8O2r3GoNufz8I3D1jRoVyW1HOWPWnY91jMnv8gS2prXleHmFL5a7m/EHBpCQLymPxJIFwXBzl88XmnwdXNrReRBXZwJ8QVJQQ/A4bot3zmzxxnrabSckB03Vt1uw6PWs4t7v2oNPuzAY9MPq73Va72Z07fDBH74OyqkqYCh89/N7YtJGx95SAHESV5LDZFaYUi/4gOCWdgJ3SzDMLFwPKKVac1QHf05tuZjz/zHcoMDkJNH9Cbpqs91Zezj32nR18oW9gjeq3aKADhTLY3oaKeFPwi0se8iU6mmWTmaD87KkBzESjyV5zh52r8R2rwaCnN+D2Z2hrsoNb+cpzoT7TVZib3gUs6Vb0BZ+BuLU6816H89ag0+x3QUHwdtsadodDimiQ8frbDx9+xhuOrs3U7RjK+MRDdbmUOt89rKa6GlNdjfkPvxqD5kQc7iB37xYAP3UaWvLii1DCR/tpiUa0GnqZFCKpzTZVVqWS5dKCL687VLJbyW4lu/tfa6OX5yoxhXpLpk+zaPpceer2FCrPgukjEw7gjStVSB5gyoWkw0dlIv39/SUI9meM3wmZ+G2lb7E8k30kVXmB+FGyHvL5TIdXaNWfrgUSSPOokk8AEgnniOhOKa6lVmK72NsbP5i5wKBeiYmIub0oUQidBceeR47b8IA5vgi9F9kgcEJA7NVz6pSupbIkK0uy0kaVNvrzaKPKkqxkt5LdP6bsbrQks8FWyk4K4+WS06kzBmLK9zLFHRRIUqSxROSS0wHTWsHGWGJj1bKWQ23Was6a874tOg7vOL32cN6yey3e7Tf7zVmn1a+Zuv46leNEyLIyZay3XEd5HVAEeMsv9oC5wsj3naz7L8YAujnCGgUua7sZ5hym9CaxHVvDkvwLvo9BSffaQgozNqSXzhFiGpRdYtlAl4UCnN26mBpM5RxFVsKMEXVGGeMX7tIl4cVRQLvBfX1EOd+loGgmS3pJcjEgEix8tJp9YCw3SsJUg3uyYG+5jLN/JutUp7h5iiXPznHEpzhiNv7NFgIFPbHcu2X+XQzDDhAjLuQCr3H0yt0O94ABYEMgMSuxOyv7vLLPKx1f6fg/h46v7PNKdivZ/WPK7h72ubKG1tvnUGBn+xzKNiyW2FJvKD3R/7eZTqKiKJCZs3SO+tQGJ7sCWAkJWvkhgQiP7uBXSQptjGcgq1ASFAcY4XMXRavw6PDwG6wTrM9Dg6/cJMrH879ikM/hDCanBHcwQEDKGBZgo3cTta+QH0AKXEoGTJxJjct5VsmeaiHMN/mEN7asL3reY3SkbOYAL9cqRqLHGGgCu4jkyrXMbpcbH4zrKlg8PH0ssqE1Yymbvo29QXkGlOaGSLeJcLlgwaGhCzS5Ze9XQNWxBKtRHN2ZagS3acXEpVMs1mKvBQ8ojzieXLz8+/vLV0bS5DhEG1ffLmXvgEUIyEbai4+VSLcEfnwrP/0wypyToOCw+QIGzD54F0KwaxXlfX8GCH8OkExTipUEoQDWunmpV8fB7KCo/BrpTCLjuY53CDN0yDP1XpGiox2B8Q2Dxgevzk4omYurMzXoDzzgBo9dr/S4uDGuxxLxX7q1umytTq2Fr3JUyKm9tmXcjQ3Si03wRUiz9ejOZXt1oz3cPsETbDVPA86EoiN7umXrVXs0HZn26thelo4P3nvKFJitxiRo6XQiE7wR74fivxlD1kExuL6NQYoeTRalJ6yTRNRblkFSXXZZd+tgExJ9pyAYnmQmPkOdTCaJD9aa50iR/EQrCzKvLmdnxkyPr/G+PpR0fDt8NM3YYR07rEsMCBX96nMGQCzINo6BcEAywHG6/oQEilAD92RbpahOzR9SHVQNeGldJrxbHckfRynA6eSN9AJLJ2UAhtGkTs778DKnagvVU2aytDMgP4NFehc+aMXcvEl6E2cUasofbbw44lHqM8Hbzc+N0muQ5MfB3d8J8Sqk+TMijTJy0feoPHqvfed+rLcj35JvRG7+BGHhkmjZ1+ZyRtrOH+XLhs6bH61c/6mysrB5TWL202DJl8HWftur/KLQts+bG19myn3DY78v5Zjh1Ou/BlNyp/Y7RFPLbfK2YOr0yhGt1dYkewntxatJ5pWj575ltFPyv8fcv9yUdbQ06eiaT7Kuz5iVTEw+4VV6aXN7Isfcxc1dJqT8Ymcyjmy6QDe5zLUlRZWZbs9IZbdDprnvPJfGzY5dRrHHF3e35kfJLaPMLlS4JrYxW8+etxqAOM3dyiVkWjqv1aa9eJATUoY8+De8VenSQEy5HaWfrTQbQsxH00Z+S+vOFeQCXgkeIcYc6I9iAhKuAh95Td9ivqUrSQHoLb6Q95jv6ZBS9ywzNEnvAip3SuIUy2+lQV8yOXaDvRdMeDbgAHrk6LtePvvVV6659AbQidb4OL/L2MM0YkB2vMSvc24zCxw3tGNpvdq+5wk9Fz7t/5Na2pSje6kwBMpoKYJlOJ3j6aJrC0P7b+kLlH+ojhZh6g11lA7kHDGbLggd5Hw329oGk6N+JxYr+noIkAXoayq8yWWhRWjMU/ds/eD2UFUKD7EsNII+Msk+7UazYdXJZwTP0cUGTGs0Lr+hw/h2g+Jbeq6a1rLztVJ3s2lfKEFFp8/hCo8pkJhYOqGkv++6VuLvA5m/Q6cgvP32DRtGB9iDccnr+ib1bakb8NKfTaj5WaCEqwPUuspspBymxZNhdLnJGtJHvrHsjeG3fDfF04IaXjmig3Ppgg04XjvFfx/VPsD/0Mpaqftj3+TzbzV9oAFlfk0SKvI1Gy71Bw7z4eH/AALb8HQ=
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a Campaign Template' (create-campaign-template)"
---
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"}>Create a Campaign Template</h1>
<MethodEndpoint method={"post"} path={"/campaign-templates"}></MethodEndpoint>
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create a campaign Template based on campaign.
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager 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"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the owner","example":"Mister Manager"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"deadlineDuration"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>campaign</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><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={"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={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><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>filter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN_FILTER`, `RULE`]"} schema={{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the filter","example":"Test Filter"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sunsetCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourceOwnerCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Must be set only if the campaign type is SOURCE_OWNER.
</div><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of sources to be included in the campaign.","example":["0fbe863c063c4c88a35fd7f17e8a3df5"],"items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>searchCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Must be set only if the campaign type is SEARCH.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS`]"} schema={{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"The reviewer's DTO type.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's ID.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's name.","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"}}></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** `<= 1000`"} schema={{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessConstraints</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
**Possible values:** `<= 1000`
</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`, `ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Must be set only if operator is SELECTED.","type":"array","example":["2c90ad2a70ace7d50170acf22ca90010"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL`, `SELECTED`]"} schema={{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>roleCompositionCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Optional configuration options for role composition campaigns.
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"The reviewer's DTO type.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's ID.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's name.","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":["2c90ad2a70ace7d50170acf22ca90010"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>remediatorRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourcesWithOrphanEntitlements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"mandatoryCommentRequirement"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL_DECISIONS`, `REVOKE_ONLY_DECISIONS`, `NO_DECISIONS`]"} schema={{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Created successfully.
</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","description":"Id of the campaign template","example":"2c9079b270a266a60170a277bb960008"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This template's name. Has no bearing on generated campaigns' names.","example":"Manager Campaign Template"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"This template's description. Has no bearing on generated campaigns' descriptions.","example":"Template for the annual manager campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Creation date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:44:00.364Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Modification date of Campaign Template","readOnly":true,"format":"date-time","example":"2020-03-05T22:52:09.969Z"}}></SchemaItem><SchemaItem collapsible={false} name={"scheduled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","readOnly":true,"description":"Indicates if this campaign template has been scheduled.","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the owner","example":"2c918086676d3e0601677611dbde220f"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Type of the owner","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the owner","example":"Mister Manager"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email of the owner","example":"mr.manager@example.com"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"deadlineDuration"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days).","example":"P2W"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>campaign</strong><span className={"openapi-schema__name"}> object</span></span></summary><div 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><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"format":"date-time","description":"Modified time of the campaign","example":"2020-03-03T22:20:12.674Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>filter</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank.
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of whatever type of filter is being used.","example":"0fbe863c063c4c88a35fd7f17e8a3df5"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN_FILTER`, `RULE`]"} schema={{"type":"string","description":"Type of the filter","enum":["CAMPAIGN_FILTER","RULE"],"example":"CAMPAIGN_FILTER"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the filter","example":"Test Filter"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"sunsetCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines if comments on sunset date changes are required.","default":true,"example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourceOwnerCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Must be set only if the campaign type is SOURCE_OWNER.
</div><SchemaItem collapsible={false} name={"sourceIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"The list of sources to be included in the campaign.","example":["0fbe863c063c4c88a35fd7f17e8a3df5"],"items":{"type":"string"}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>searchCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Must be set only if the campaign type is SEARCH.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`, `ACCESS`]"} schema={{"type":"string","description":"The type of search campaign represented.","enum":["IDENTITY","ACCESS"],"example":"ACCESS"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available.","example":"Search Campaign description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"The reviewer's DTO type.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's ID.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's name.","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set.","example":"Search Campaign query description"}}></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** `<= 1000`"} schema={{"type":"array","description":"A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set.","maxItems":1000,"example":["0fbe863c063c4c88a35fd7f17e8a3df5"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessConstraints</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
**Possible values:** `<= 1000`
</div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ENTITLEMENT`, `ACCESS_PROFILE`, `ROLE`]"} schema={{"type":"string","enum":["ENTITLEMENT","ACCESS_PROFILE","ROLE"],"description":"Type of Access","example":"ENTITLEMENT"}}></SchemaItem><SchemaItem collapsible={false} name={"ids"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Must be set only if operator is SELECTED.","type":"array","example":["2c90ad2a70ace7d50170acf22ca90010"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"operator"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL`, `SELECTED`]"} schema={{"type":"string","enum":["ALL","SELECTED"],"description":"Used to determine whether the scope of the campaign should be reduced for selected ids or all.","example":"SELECTED"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>roleCompositionCampaignInfo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Optional configuration options for role composition campaigns.
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","description":"The reviewer's DTO type.","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's ID.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reviewer's name.","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":["2c90ad2a70ace7d50170acf22ca90010"],"items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>remediatorRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the chosen identity must be a Role Admin or Org Admin.
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"Legal Remediator Type","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the remediator.","example":"2c90ad2a70ace7d50170acf22ca90010"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the remediator.","readOnly":true,"example":"Role Admin"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included.","example":"Search Query"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available.","example":"Role Composition Description"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sourcesWithOrphanEntitlements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented).
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the source","example":"2c90ad2a70ace7d50170acf22ca90010"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE`]"} schema={{"type":"string","enum":["SOURCE"],"description":"Type","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the source","example":"Source with orphan entitlements"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"mandatoryCommentRequirement"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL_DECISIONS`, `REVOKE_ONLY_DECISIONS`, `NO_DECISIONS`]"} schema={{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9079b270a266a60170a277bb960008\",\n \"name\": \"Manager Campaign Template\",\n \"description\": \"Template for the annual manager campaign.\",\n \"created\": \"2020-03-05T22:44:00.364Z\",\n \"modified\": \"2020-03-05T22:52:09.969Z\",\n \"scheduled\": false,\n \"ownerRef\": {\n \"id\": \"2c918086676d3e0601677611dbde220f\",\n \"type\": \"IDENTITY\",\n \"name\": \"Mister Manager\",\n \"email\": \"mr.manager@example.com\"\n },\n \"deadlineDuration\": \"P2W\",\n \"campaign\": {\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 \"modified\": \"2020-03-03T22:20:12.674Z\",\n \"filter\": {\n \"id\": \"0fbe863c063c4c88a35fd7f17e8a3df5\",\n \"type\": \"CAMPAIGN_FILTER\",\n \"name\": \"Test Filter\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"0fbe863c063c4c88a35fd7f17e8a3df5\"\n ]\n },\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"Search Campaign description\",\n \"reviewer\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"query\": \"Search Campaign query description\",\n \"identityIds\": [\n \"0fbe863c063c4c88a35fd7f17e8a3df5\"\n ],\n \"accessConstraints\": [\n {\n \"type\": \"ENTITLEMENT\",\n \"ids\": [\n \"2c90ad2a70ace7d50170acf22ca90010\"\n ],\n \"operator\": \"SELECTED\"\n }\n ]\n },\n \"roleCompositionCampaignInfo\": {\n \"reviewer\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"roleIds\": [\n \"2c90ad2a70ace7d50170acf22ca90010\"\n ],\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c90ad2a70ace7d50170acf22ca90010\",\n \"name\": \"Role Admin\"\n },\n \"query\": \"Search Query\",\n \"description\": \"Role Composition Description\"\n },\n \"sourcesWithOrphanEntitlements\": [\n {\n \"id\": \"2c90ad2a70ace7d50170acf22ca90010\",\n \"type\": \"SOURCE\",\n \"name\": \"Source with orphan entitlements\"\n }\n ],\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Manager"} value={"Manager"}><ResponseSamples responseExample={"{\n \"id\": \"e7dbec99d49349c8951bd84f58a05120\",\n \"name\": \"Manager Review\",\n \"created\": \"2022-08-02T19:16:42.632Z\",\n \"modified\": null,\n \"description\": \"A review of everyone's access by their manager.\",\n \"deadlineDuration\": \"P14D\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\",\n \"name\": \"Test Manager Filter\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": null,\n \"searchCampaignInfo\": null,\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Manager Review\",\n \"description\": \"Review everyone's access.\",\n \"deadline\": null,\n \"type\": \"MANAGER\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Search"} value={"Search"}><ResponseSamples responseExample={"{\n \"id\": \"b7e6459eed5247ac8b98a5fed81fe27f\",\n \"name\": \"Reporting Access Review\",\n \"created\": \"2022-07-28T19:19:40.035Z\",\n \"modified\": null,\n \"description\": \"A review of everyone's access to the reporting system.\",\n \"deadlineDuration\": \"P14D\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\",\n \"name\": \"Test Search Filter\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": null,\n \"searchCampaignInfo\": {\n \"type\": \"ACCESS\",\n \"description\": \"Identities with reporting abilities\",\n \"reviewerId\": null,\n \"reviewer\": null,\n \"query\": \"@access(name: (\\\"reporter\\\"))\",\n \"identityIds\": null,\n \"accessConstraints\": []\n },\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Search Campaign Review\",\n \"description\": \"Review everyone's access to the reporting system.\",\n \"deadline\": null,\n \"type\": \"SEARCH\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Source Owner"} value={"Source Owner"}><ResponseSamples responseExample={"{\n \"id\": \"b9f41bc69e7a4291b9de0630396d030d\",\n \"name\": \"AD Source Review\",\n \"created\": \"2022-08-02T13:40:36.857Z\",\n \"modified\": null,\n \"description\": \"A review of our AD source.\",\n \"deadlineDuration\": \"P1M\",\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": {\n \"type\": \"CAMPAIGN_FILTER\",\n \"id\": \"e0adaae69852e8fe8b8a3d48e5ce757c\",\n \"name\": \"Test Source Owner Filter\"\n },\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": {\n \"sourceIds\": [\n \"2c918084707deba501709d45ce4e5569\"\n ]\n },\n \"searchCampaignInfo\": null,\n \"roleCompositionCampaignInfo\": null,\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"AD Source Review\",\n \"description\": \"Review everyone's access.\",\n \"deadline\": null,\n \"type\": \"SOURCE_OWNER\",\n \"status\": null,\n \"emailNotificationEnabled\": true,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"RoleComposition"} value={"RoleComposition"}><ResponseSamples responseExample={"{\n \"id\": \"b9f41bc69e7a4291b9de0630396d030d\",\n \"name\": \"Campaign With Admin Role\",\n \"created\": \"2022-08-02T13:40:36.857Z\",\n \"modified\": null,\n \"description\": \"Campaign With Admin Role\",\n \"deadlineDuration\": null,\n \"ownerRef\": {\n \"email\": \"support@testmail.identitysoon.com\",\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"scheduled\": false,\n \"campaign\": {\n \"created\": null,\n \"modified\": null,\n \"filter\": null,\n \"sunsetCommentsRequired\": true,\n \"sourceOwnerCampaignInfo\": null,\n \"searchCampaignInfo\": null,\n \"roleCompositionCampaignInfo\": {\n \"remediatorRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"7ec252acbd4245548bc25df22348cb75\",\n \"name\": \"SailPoint Support\"\n },\n \"reviewerId\": null,\n \"reviewer\": null,\n \"roleIds\": [\n \"b15d609fc5c8434b865fe552315fda8f\"\n ],\n \"query\": null,\n \"description\": null\n },\n \"alerts\": null,\n \"totalCertifications\": null,\n \"completedCertifications\": null,\n \"sourcesWithOrphanEntitlements\": null,\n \"id\": null,\n \"name\": \"Campaign With Admin Role\",\n \"description\": \"Campaign With Admin Role\",\n \"deadline\": null,\n \"type\": \"ROLE_COMPOSITION\",\n \"status\": null,\n \"emailNotificationEnabled\": false,\n \"autoRevokeAllowed\": false,\n \"recommendationsEnabled\": false,\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\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>
Reference in New Issue View Git Blame Copy Permalink