mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
192 lines
88 KiB
Plaintext
192 lines
88 KiB
Plaintext
---
|
|
id: put-source
|
|
sidebar_label: Update Source (Full)
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztPWlz28aSf2WK+yG2i6RI6uZ+2KIpWmaeJGp5xC8ru2QQGJKIQYCLQzKj0n/f7p4DJynK0TqJg/dSCQXM0dPT90w3HireivtGaHtu36q0K6soHHmRb/JKtRJwM/LtcF1p3zxUJgH3u54b8q9hJwoX8KxiW247oMZBe2m4xpxXPj1+qlZCYx7gezFQUIFHFg9M317hNDDJeGEHrHPdZ9HKMkIeMIOJcZjtsr7F3RBmvfLuqywKbHcOr2eR4zBv+hs3Q+bzlc8DaERQ11nfZV644D6793wrqDL4zfhXOwixq4Dho2t67syeR2KlDKY3veXK4SF31jigY5jcqn90P7ojb8nZzOaOBWD5ANFyGYXG1OHMcC1mGq7rhWzKmbkw3Dm3qiyIzAUzgjZ2fsNsC/8drlcc/2sApjxAIcx6Rw8ADBfW4PmpP7qOEQT4ZAX/xVVce45t2jzAMTthyJerMGChx5aeZc/WuMJAA3lvA2oAIZETIvoMdtBoMO77nk/r6UC/L9yFZuGCDYbnt52zy/5VlY0Gk2G3p/7yfPVgNHlLzzTsa8SWz/83sn1uIRCmAROGcgthDqCUleEbS0CmHxCt2LjJKwOopFpx4QX8ZVtIUOaCL41K+6GCCIKnQejDJlUeqxU1QaUd+hHPEwyXO8loIP7VwN2DNy3ztHnSONk/tJqnTePkqNE8tFonB4eH0wOjtd86rSBB4uA8CN961honz85lIlm7Ib4yVivAPBHJ3m8Bzv2Qh1rQIS7bR+YJYaPwLUCWWxnObVgD11kXLwxp1baYNyOq1ZyXW9/h0Yl52Do1YX3wyzSOZqcNs7nfOkDcCRTnp05P9T4CHq0hOETN2EnNG+TnvVwraB4zAz1znsTLLdORRIB/8LXp+SsPGBX6wi4hf6zrCIV373If50/PN+Qz7nMXSANo04BJ7l1kfCVG2EDt1vbdE2+zgyPh4RsEXYqfKcfhfTWrFY+sEcLdaIkCsH/Wuxr3x7+iBIzXqp/CmoppJg1D/0whzpZregaFNPe/mUIsOwC5uE5RSiEEl+srHP/xEWYynSgIn9wmHApEnWfasM0W68pO+T1yQe4jMIp7Yta9EYuqCslC/T59jz3tXkxG494wvaXq4bN31NQrz23o0VHz6Gh6OG3AhjaPjs39Fp/tN42joxfd0CIAupoB1cbQ1hqm6UVuCG997pCI7JJSfZolO6InS3Rloi/zNnFnduf//3e20+0OJlfj2+5gOOxddMb9wRX8vnrXP09v9pZ2z95/iVOUeRozwlQp5HHScubhqdByhyf7x63j1sGh8aIksSNMZ0o4sxsh0GtHrZOj409Fu72JgIaRU7CNafJh2AgAM0K0vpjlse7g8vqi9+8kgGCGLbzIAU0KqhbNsygAuXK/AMNnE9niaD+Fqm39L0GCw8lFL01s9OTZZOUjXosI6LhxYraODw4aTfplnBjHRw2QMC9KQLnZe+IX7aQgBeEu+IlNuQTTC+dDI8xxBjMyJLerbLmzYCD79jQK+dVOC7hKkrrqipQWoU0NhrCELUledYb7emc4ETaJXKSzFK/EA5E5rggQRnU870u0osZy4J8CrUbrKTTJ92K7RYM/sDY1RHqRATd88FeIM0J/jZQJT2c2LMnQKxdeVxgv2feWyeVqqDbADwuAmYVtsHGjH6sPOQ5Lr+ad7YDykQacQKgV4bqLtojcIyOEtdng7C2TrWgRgdRF2jPUuwE+kljWnrIZwad5/FRIpTsILMRTftXYsSqkU0I0scAmxpiJldoBSqQgms3Q+3PDUih9V6E05cD+/Nr37uwAxoWJNmy3Vkh+5AZKFHS75xQiAOnl3QckSUywnoAUfzeU97NKjM0AROgtJpWOj4wHUHwCxinV0nemAOHqJ/BYMXzfQG/HDvky+fw7epFgW171uuPB8HbUfd+77GRcj+zbZ++KjG/s7FMeHx+/6L4UzH+5HomHtCvpES9AfmNXjTuS7KK9xG6QHCw2I3KoEpjaFkOatvZbRhzFkvqPdNcfG3QaDzr3vWglFE42/ldAiFnu/xMJ87ozGn0YDM9urwcX/W4mypF9+WyyXCEOnhHqeGmyLJj/cs2u5Q6xa/F6ZwLNhDyukzu9VnRbLybcLC7TJJb2CuEXnzYO909PGjGJxR59Dv7qH5nlGJGuZ/mFuxYor9wUSNkzboSRX0jRaewN6IfhMNUjdv3Aqg6iFSwEEThd61ODeoF8znv3k/F7jLt1O+MePEYfcjDq0++z/hA4+Pa6N7zsj0bgzo/o4ag7+KWXYOveVeftBba/7Fx1zuHNxWDwr8k1PLga3A47V2eDy9tOt9sbYffr4eDfiMJRrzPsvocf4x44rWLuydXFoPsv+jEaDyfd8WTYO7sdd4bnvTH2Hb3vDHvXg/7VWD4U4/3SR9j6V+fw5/lwMLm+zTwc/XrVzT5Tm4pLngyHgIHbxCMVyhhcXfx6O+z996Q3wsk6Z2d9DGt0Lm5Vi/glLLZzfj7snVPkQ8Eyun3f+aV3e9m7fNsbjkSzBEKzYMFbuYStbYoQVNAsv4E5NAx772DHJpP+Wf446jkk5yqaw+OaJE21yUWUx1iyT0AHOrVwARJ+vqATFXQwxPkCjaDJsLg7HlJ5AdC2emOCyNKd88suHsXnsCoyOUXM5pr7SztAMzSQ46RIvXgQEJGmd8fJ/ZJmEtm44M34ARm+pMfEiIJVNgBjWDiGPUNkKv8ZDF7uoii28CgK5qLfNFaa24qBQycbBwVHW/psABKdJqzpEA+kME7D8QSLzshmHEZnyVMHbyUxDZI7y88ER/ZhChLLA6rBk0EJEvMBI+A0w/p4INCDk8x5KLzZV6/ZkocLzwpU4EodK5LZTx341xW0FFEE0OSA7CUBQqIlNTtSKmzDHWoYWBxo/q9r2hzDFSejkmbZB/I6FQ2zRdy8in5LwgNBOAJApsXFySFxhOyGGAVMEi0heJK80y4MTk9qlIBJMI2QiPhLiUT8LWTiJvrdQDKOZ34RFBO54nddjJWXGk9xBjhyYE+ZyP4WGxs+7JQg5Zww/oaRmGWEBmFktADkXXs2+PasH+pgESgtGzEugwMgaDpnVXZx1rmWEwVq57VQyxHAFLaaUEXEc+8jLUtcBXX23rgTMR1AmxRzDGMPtpJ2cq+Ee6rJE7FMIYolCC5kGQDacAIPXqPzSj0FIQgaF8tdxQKGQKMe08T4yIYzwZ5Sygr8SSE7n/t8Hsu5vLLbafFSHr3U0okYsho2B4geR+OeBWvXBBZxvShw1mIfpQbe0lt5AvKeASxjZGOASZIDtXY5yGOxatWcrj8IoVYUELcpkv9b5JoUkZCczVOEpXAk9FPGZmgzuh8hQUZbK9AiD5XDTCo3fbwU+WAChxo+0poFRscmpqJze7oCorCJMHtRyChSJzZHMMdmo+XpwS3LliaA5hgp8hOmTpt19MKJ7rMyv5Bu04ZRCpSlZ3EQskSnQHTLKaithb0Sa8RwLD1KxG9lpEl0ULdhDJLwABHqNUHz+S5KaIpOUvPx2QydDhEtVpSutw9gA6GlA9yZtW0x79qs71pIB0n+SmoWukITk7qUH6gv8uKDtJiWYqS/8mYPMX0RDYsrPPK6UJXZpDWAFKMl6a0i2ISwykGXgEliT4kSaazItdLg4raDuC8EfBckeiuyQ6U+pamBbaSSBwb5wsiRSS9b4nu7wfziWFfi8x+F84QNu4v70RZgCWdTa3N1nwx12ZP7RiBv4SYFyxM+zveAJBULyfjT6rxHXBp6J/YJ4zFxOKPQP8350tphzjTMzFfoAGvPFiMOKuK1PRA0AhsbtBYXUlDFwoJ1ACQhY2HCowB7vD6vs46JV/mYPvyusg9AQZYBP3ho1sFAmrG1FxEPCGeN7i+eccde2khz72xHKYAqtVxGQJkBF2zxWTOBEXSDu88MCNdfM32/Dkn2Mwb+PtdZajsGK+6SvViTsCHuNZM9jYeu5kfxlEJh6R03aOk1fSkrNQNdYXx6GtR+eJdzDQszHES8lQq6/WzcGczEsQRra7UUZKSGjd7czDAzMAaG7azIvNZN64gWvbwU0PocszCAuhFBgmRMlrpT+p+C6SwblKovT0yRmjD0B/9NgflQWXDDCRfdBTe/jO0lB4Om0t5vVCsYIhjREW0StpuKibcsI7rqtIQlAoFT2BEvsI4XIGoXnpMMriJ25nSrB71GIxSP9lv5A+OITAwCt4GwNhsN6etpxhBnxR4LvtjiHFvMy1bgPqbX1Ww8iiXoO68JmKae54DTkAPhgziKjvDyb6zAtJFEl09VMFqGYNQ57bXvzYCd6jTmzIgcWOgMdAlPwER/67NcJCVkWBFz336Qe6l7MN1FurUAlL6r+ecfz51j8Oaqc9XtCQmfDsTn3j47Eh+jjtSlwN2ucfkW/O9F4/JPQnO5Ltw6EaoXjLf+Rro0mOwf32HdSHjYFY8UgRGiHSQj+BbUUt7bAM7zq2xuk+uqJY7tCn4mEx38t8U6cXU+0MABjYKxl0KKut09BvV5+77XuRi/pzOZAL3KHeQ2CCmAb7lCt/KeTAx5gUFGkmhmcFZBoLF7I2AgwkMVteKZK9uNVrPWOK21TsbNw/bBSbt1Wt8/AZo5OtpvNP4nJaH7OxDqWN+hjvXdznprt3s1OEXq1qRWBiQrccHmwgODF3clE6pNW00Z8yEBCzQd72SyJIVF3Je9ii16FIqvU/PikzRiU/7ermhO6N+0v5i5lW8pc6emJ0Zs8B2nwaSQWggkJ3VPrA0I03KohHLTHbKE1qo14B8gtIP2YaPd2K+ftI6JwiiTwn4ZgIjW9YC7gHVQazRrrf1x86TdOAHI6ienCNZj4QVnce89ac19ytrbKNuoc7ACZ0lomlajkVc0E0q4sVQyhQoHdNx1HEIShgzFjZDZhWG8oCC6v15hb9NeLbhfw1ygairOji6mxalZjQR4Op8HLDsvsmpTA2NRGLC2TR5UUUykWqm8I8wdsOduvVKmaJQpGmWKRpmiUaZolCkaZYpGmaJR3oUtUzTKFI0yRaNM0finCaUyReOfTgFlikaZolGmaJQpGmWKRpmiUaZolCkaZYpGmaJRpmiUKRplikaZolGmaJQpGmWKRpmiUaZo/MA4L1M0yhSNMkWjTNEoUzTKFI0yRaNM0ShTNMoUjUqZolGmaPwtUjQOirIyug5eJWI9/GgHWIdDFWiz5a0I6RtNPYs+xmG7d2CYWS+YF2HxEEyWrmftQNvvbJfX5r5hI4T0nRGgOUuG5ygIvMTbMmJIxY3ieyQpHAMm6k321rBgvWJ9XbkY9Ax8w8Tjgl2ofuLa0J+pLihoVGS7YFp+zI3pUeO0dTA7OjCM1slB8/hwejoz9vcbp4enp0R5PAhAOT19EnrOYd9B6DueCTvyOyAECB9wTwDQ5LvfS6ExdpQtoq1epoSXyYQc9rZ7zQ6OgejdeUTPjXkGCW5tMsoZQrByMfDAt+d2YR6JsmfOeu86kws8a9SnjjhW7tyu4yrVDKACLah8IrkAZM0ATFWTAtdv5KhvdOhaN5QnQNLpkwodesjZC3okh45vRypWMsWXjNgru87rVbDkUDzQ1USRnCRjcm86pslXYe1CYvINalGL+6/By4wDkvLy4tKgKK5hWSKMG5IjRcEQFREFlW9n/aEYlVmzVAmQi+SmIHMA5DtYK2YI/hvRRIoLNbVIEJXpZEnMpaEbJ5BGKF2DPjFDeRRClzvREoa12XQYShxMsW0QPK5qpyVW8t4pibtLAcxZ6NE7ERh6ku+uHRA/lH8WJy/dccl8dJdDSCOejBtLiSQvelBn2Upvl2J88W2lkndL3i15d0fezb4cylxU+ZZMn2ZBQqorgxGoPHOmj0/U43rqY2Tymq7YSPpqmTSRfv4wlt85w0OTryu0z17QPhKqPAd8R++HeD5Vd/KV6o/3AgEkPIoVzEAScatNcMcQE6IEqvbzs73z/KkNBOoWmIh4xUMHNf3IpWNuI6jSCRjeWF8Yd1xddSAJSNc5rJqIxJWWZGlJltqo1EY/jDYqLcmSd0ve/Xvy7lZLUkNF3CLtpCBaLg1/LShNvsfV4rdw95mqihInstNWZa0VHIxpG6uSthwq01Zz2pwdm/zAMg6so/3TWcs8ahmHx83j5vSghVfsY11/E/OxZrI0TyX2W+wjoZguiOJNSSCuIPQ8Kx3+i/DbxzO6ORHGJjHsHRhwj59i2/EgbzteeSGsDbNia/E9vkx4cTK8EIdZYnjEm6wS46sTr/SlKsrTLE3H0nQs1U+pfn4Y9VOajiXvlrz79+TdZ5mOB0+ZjgfPMB0PGJpYVHjkzzQdLVukKclqIepuv8/lZV8ZfZRsL68VK0MvZUW2TgvuQHl05WqtjKUgFYl0Y3ShePOw2Ae09VVbyuqag4h08daJ7YmaenhiX2OU+CovJIhKLjCuv651ZnijUvCMojc9i+2aTgQQklBwPFEn5d6wQ12xQVRPMeYgqF8wxil36w/Fg9kQV3yBK2a9rybnyPM6/ntYdEugj/cpUVyMxF5vuC4gYuaGC26ETk/TJmhpqpemeqnuS3X/Y6j70lQvebfk3b8n7z7DVJfW0GZTHRrsbKpD23qDaVvqHd0M/94WO7GKhIDIm3km2epWbIOTXYFZztB+FZEMMcIF/LEnE4z3HmzrER4L019AEvkOtFiE4Spo7+09wAbBxjzWjZVdV8UGXe++bnrLvbv9AnETF1sAgWVF4tpy57ov/Ys6odW3KbOPyJImEEiWl+zjBJ+t46u72mtYDBPDVBNJ9vQYa2uAC/FTIFOdECm5NcLaJr7z+NR6ftnftg4xyIZ1FKFv61zQngGUmeUh+J9wu0R1cyqHJWafBFiIkKRUJ8I9jvUHRvnzOUEDbNZib7nhU8IZXnx59fOH8Ws2RwuTOFxUiOQ2ugTAI9dAIiTBOuoSCHYipRLXhuikrtkgx7CZAwtmH90R5+wmWaV9CLKYUNpJ1Uz59ErtjMXvuINar55M+Vru2Za7BxjaS9daeS0Ke6IrkEihqH90VbZcnPUqliiy9m5Wal1GYl3fCsR/qNFqYrQajRa8zkAhUHtjimvbJrAtDmE4AWHrmycX49US46HfBE9w1CwMorALwZG+HGWqXftmOFLj1XC8NBwf3Q8L28wWy1E1GWRRgz6mW3gB/y/GkHSQDW7mEXDRN4N1j5PWiCNqrUYCpJqYsmbXwBgk+C6AMVxBTMYUlTHZIrKIKrHkZ9pZ4PnPlFP7ObVmenwDOhNbWp4ZfDPMOGENJ6wJGRBI+IVKQsIC3sY1kBwQBNCN958kgQQ0IfPEWIVSnYbfoz6oGkwAlUYJVm3xRzsWcPIXoxfYWrcBEVyhUnryuhgWnpFjPcb5g7/LUs0iCpDFYB5exwN1mMGbgFefZaKK/KutF1fciYMl+KWIl5bSGyTJX0fu/kkSr5Q0P6KkkdYtBh1lKO+tZ617ceq1LFYYf+Bkm7FV+C2SxKdIJI/qT3pkaiZu/CZHNQZDfDsj9eUMVVpUflUiPejm70IUlHvUH3DY/vkGOeGWLxtsKwaZ/BCBhuF5nwfY9nEACRyVHM6AsbFusAYjXeP3qcLzhQXldV3zjWXZk5XbN9cMf9F1bK5V/aLT6ILIf5squkVFdH+cSqrJQqrftaCKrj6QLzSSqjOSz7bOFwnZoUrHxiIdf7xwRkHdjGYjV7ZCZvNvqBohcZErrbCD+Kd6CAnxv6FWQaJSgYjhqToCxZn8OpH/yez6THL91v2S0i2XtJ7PWRcJ5lvzy7NJ4Ymc8M2Z2slE7S2J04B3MC9pZ2TYL2nUiuhM/qguoLL78G94S5Y5hc0AIXFhvOQwKxDnaMOSDW8ubE5B/hWsASM9VbQjvSXZ3SvfQ2Ofy0puc1onVtYxHGNqO/jhD/ZBViX1MYKKyTUw6m+eDKWOgFSpSiQ7U4Ya6MvlMnLxgx4ARLRkBpiDT1hzWLM1Ek6H3BgBkCgKqnspCxzNREQFfXSA+8tgMBuJ7+gljLYn5gKbLZBHwYDIhL0VL2Qo9SK2S4fbnhobLMXagjvEHiAQuRukLLr+ODciDObK+weeP9+TnYI9bAuDYGhTEMN+vVFv4KOVF4TA9YlxxWcN1VcNX72LHOd1lpge4sNvYT+iDxVRxyBRoiP1wcKqRLtBFZF0Pb/UbYo667tyu3R5Rx5/w0TA9NFNVSKir0d4yH8hd9a6BlgdPQqq3kjnSaJMmw00ReQrK6e5qgwtVZ20qiyI0EMK2tj5DbOpgCNKP/xvSmTiA839qT9I6uOTrGLGMUFa8+UqJBolVl9LnpRAUlElQAga+HTH46DRkCfp1F16vkTWg+H5befssn9VZVJIyr+w8KqUmpO39EzDvhYFhkTRBWIUdM9DuYV1cmyktMcI6t4KD/uQTiIR0RVh85uKDJtD6zaoAFCXC6AjfPHwgAdBGER+xMdUzwuef4pjxGSfqJLHWvNsJK9XQwnta7rKIsnStjYBqs4u3XV8bFGBn184nnZAP6rPLo6jCBTxQt5/qJF8jzvmLnag2SN6iCOurW0/JY4drifIrlh2gq69iAMU37iHh/jvduUj/B99rZUQFtCInj9U1HEktBHDqrBRUdRE/gCMQ7P/A5tKw54=
|
|
sidebar_class_name: "put 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 Source (Full)' (put-source)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Update Source (Full)</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/sources/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API updates a source in IdentityNow, using a full object representation. In other words, the existing Source
|
|
configuration is completely replaced.
|
|
|
|
Some fields are immutable and cannot be changed, such as:
|
|
|
|
* id
|
|
* type
|
|
* authoritative
|
|
* connector
|
|
* connectorClass
|
|
* passwordPolicies
|
|
|
|
Attempts to modify these fields will result in a 400 error.
|
|
|
|
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
|
|
|
|
## 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 Source id","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the source","example":"My Source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</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"}}>
|
|
|
|
Reference to an owning Identity Object
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}></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"}>cluster</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the associated Cluster
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`CLUSTER`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}></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"}>accountCorrelationConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to an Account Correlation Config object
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}></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"}>accountCorrelationRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>managerCorrelationMapping</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Filter Object used during manager correlation to match incoming manager values to an existing manager's
|
|
Account/Identity
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"}}></SchemaItem><SchemaItem collapsible={false} name={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}></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"}>managerCorrelationRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>beforeProvisioningRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>schemas</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of references to Schema objects
|
|
|
|
</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={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CONNECTOR_SCHEMA`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}></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"}>passwordPolicies</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of references to the associated PasswordPolicy objects.
|
|
|
|
</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={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PASSWORD_POLICY`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"features"} required={false} schemaName={"SourceFeature[]"} qualifierMessage={"**Possible values:** [`AUTHENTICATE`, `COMPOSITE`, `DIRECT_PERMISSIONS`, `DISCOVER_SCHEMA`, `ENABLE`, `MANAGER_LOOKUP`, `NO_RANDOM_ACCESS`, `PROXY`, `SEARCH`, `TEMPLATE`, `UNLOCK`, `UNSTRUCTURED_TARGETS`, `SHAREPOINT_TARGET`, `PROVISIONING`, `GROUP_PROVISIONING`, `SYNC_PROVISIONING`, `PASSWORD`, `CURRENT_PASSWORD`, `ACCOUNT_ONLY_REQUEST`, `ADDITIONAL_ACCOUNT_REQUEST`, `NO_AGGREGATION`, `GROUPS_HAVE_MEMBERS`, `NO_PERMISSIONS_PROVISIONING`, `NO_GROUP_PERMISSIONS_PROVISIONING`, `NO_UNSTRUCTURED_TARGETS_PROVISIONING`, `NO_DIRECT_PERMISSIONS_PROVISIONING`, `PREFER_UUID`]"} schema={{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING","PREFER_UUID"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE","title":"SourceFeature"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"connector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Connector script name.","example":"active-directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorClass"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorAttributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}}}></SchemaItem><SchemaItem collapsible={false} name={"deleteThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"authoritative"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","default":false,"example":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"}>managementWorkgroup</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to Management Workgroup for this Source
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"healthy"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When true indicates a healthy source","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"}}></SchemaItem><SchemaItem collapsible={false} name={"since"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of connector","example":"active-directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectionType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of connection (direct or file)","example":"file"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorImplementationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector implementation id","example":"delimited-file"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date-time when the source was created","format":"date-time","example":"2022-02-08T14:50:03.827Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date-time when the source was last modified","format":"date-time","example":"2024-01-23T18:08:50.897Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Updated Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design.
|
|
|
|
</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":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable name of the source","example":"My Source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable description of the source","example":"This is the corporate directory."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</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"}}>
|
|
|
|
Reference to an owning Identity Object
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the identity","example":"MyName"}}></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"}>cluster</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the associated Cluster
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`CLUSTER`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["CLUSTER"],"example":"CLUSTER"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the cluster","example":"2c9180866166b5b0016167c32ef31a66"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the cluster","example":"Corporate Cluster"}}></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"}>accountCorrelationConfig</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to an Account Correlation Config object
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG"],"example":"ACCOUNT_CORRELATION_CONFIG"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the account correlation config","example":"2c9180855d191c59015d28583727245a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the account correlation config","example":"Directory [source-62867] Account Correlation"}}></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"}>accountCorrelationRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to a Rule that can do COMPLEX correlation, should only be used when accountCorrelationConfig can't be used.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>managerCorrelationMapping</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Filter Object used during manager correlation to match incoming manager values to an existing manager's
|
|
Account/Identity
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"accountAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.","example":"manager"}}></SchemaItem><SchemaItem collapsible={false} name={"identityAttributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.","example":"manager"}}></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"}>managerCorrelationRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>beforeProvisioningRule</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`RULE`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["RULE"],"example":"RULE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the rule","example":"2c918085708c274401708c2a8a760001"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the rule","example":"Example Rule"}}></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"}>schemas</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of references to Schema objects
|
|
|
|
</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={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CONNECTOR_SCHEMA`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["CONNECTOR_SCHEMA"],"example":"CONNECTOR_SCHEMA"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the schema","example":"2c91808568c529c60168cca6f90c1777"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the schema","example":"MySchema"}}></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"}>passwordPolicies</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of references to the associated PasswordPolicy objects.
|
|
|
|
</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={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PASSWORD_POLICY`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["PASSWORD_POLICY"],"example":"PASSWORD_POLICY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the policy","example":"2c91808568c529c60168cca6f90c1777"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the policy","example":"My Password Policy"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"features"} required={false} schemaName={"SourceFeature[]"} qualifierMessage={"**Possible values:** [`AUTHENTICATE`, `COMPOSITE`, `DIRECT_PERMISSIONS`, `DISCOVER_SCHEMA`, `ENABLE`, `MANAGER_LOOKUP`, `NO_RANDOM_ACCESS`, `PROXY`, `SEARCH`, `TEMPLATE`, `UNLOCK`, `UNSTRUCTURED_TARGETS`, `SHAREPOINT_TARGET`, `PROVISIONING`, `GROUP_PROVISIONING`, `SYNC_PROVISIONING`, `PASSWORD`, `CURRENT_PASSWORD`, `ACCOUNT_ONLY_REQUEST`, `ADDITIONAL_ACCOUNT_REQUEST`, `NO_AGGREGATION`, `GROUPS_HAVE_MEMBERS`, `NO_PERMISSIONS_PROVISIONING`, `NO_GROUP_PERMISSIONS_PROVISIONING`, `NO_UNSTRUCTURED_TARGETS_PROVISIONING`, `NO_DIRECT_PERMISSIONS_PROVISIONING`, `PREFER_UUID`]"} schema={{"type":"array","description":"Optional features that can be supported by a source.","items":{"type":"string","enum":["AUTHENTICATE","COMPOSITE","DIRECT_PERMISSIONS","DISCOVER_SCHEMA","ENABLE","MANAGER_LOOKUP","NO_RANDOM_ACCESS","PROXY","SEARCH","TEMPLATE","UNLOCK","UNSTRUCTURED_TARGETS","SHAREPOINT_TARGET","PROVISIONING","GROUP_PROVISIONING","SYNC_PROVISIONING","PASSWORD","CURRENT_PASSWORD","ACCOUNT_ONLY_REQUEST","ADDITIONAL_ACCOUNT_REQUEST","NO_AGGREGATION","GROUPS_HAVE_MEMBERS","NO_PERMISSIONS_PROVISIONING","NO_GROUP_PERMISSIONS_PROVISIONING","NO_UNSTRUCTURED_TARGETS_PROVISIONING","NO_DIRECT_PERMISSIONS_PROVISIONING","PREFER_UUID"],"description":"Optional features that can be supported by an source.\n* AUTHENTICATE: The source supports pass-through authentication.\n* COMPOSITE: The source supports composite source creation.\n* DIRECT_PERMISSIONS: The source supports returning DirectPermissions.\n* DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.\n* ENABLE The source supports reading if an account is enabled or disabled.\n* MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.\n* NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.\n* PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.\n* SEARCH\n* TEMPLATE\n* UNLOCK: The source supports reading if an account is locked or unlocked.\n* UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.\n* SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.\n* PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.\n* GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.\n* SYNC_PROVISIONING: The source can provision accounts synchronously.\n* PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.\n* CURRENT_PASSWORD: Some source types support verification of the current password\n* ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.\n* ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.\n* NO_AGGREGATION: A source that does not support aggregation.\n* GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.\n* NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.\n* NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.\n* NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.\n* NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.","example":"AUTHENTICATE","title":"SourceFeature"},"example":["SYNC_PROVISIONING","MANAGER_LOOKUP","SEARCH","PROVISIONING","AUTHENTICATE","GROUP_PROVISIONING","PASSWORD"]}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"connector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Connector script name.","example":"active-directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorClass"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The fully qualified name of the Java class that implements the connector interface.","example":"sailpoint.connector.LDAPConnector"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorAttributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Connector specific configuration; will differ from type to type.","example":{"healthCheckTimeout":30,"authSearchAttributes":["cn","uid","mail"]}}}></SchemaItem><SchemaItem collapsible={false} name={"deleteThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"Number from 0 to 100 that specifies when to skip the delete phase.","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"authoritative"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When true indicates the source is referenced by an IdentityProfile.","default":false,"example":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"}>managementWorkgroup</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to Management Workgroup for this Source
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`]"} schema={{"description":"The type of object being referenced","type":"string","enum":["GOVERNANCE_GROUP"],"example":"GOVERNANCE_GROUP"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the management workgroup","example":"2c91808568c529c60168cca6f90c2222"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the management workgroup","example":"My Management Workgroup"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"healthy"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"When true indicates a healthy source","default":false,"example":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A status identifier, giving specific information on why a source is healthy or not","example":"SOURCE_STATE_HEALTHY"}}></SchemaItem><SchemaItem collapsible={false} name={"since"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Timestamp showing when a source health check was last performed","example":"2021-09-28T15:48:29.3801666300Z"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of connector","example":"active-directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the connector that was chosen on source creation","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"connectionType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of connection (direct or file)","example":"file"}}></SchemaItem><SchemaItem collapsible={false} name={"connectorImplementationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The connector implementation id","example":"delimited-file"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date-time when the source was created","format":"date-time","example":"2022-02-08T14:50:03.827Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date-time when the source was last modified","format":"date-time","example":"2024-01-23T18:08:50.897Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"name\": \"My Source\",\n \"description\": \"This is the corporate directory.\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"MyName\"\n },\n \"cluster\": {\n \"type\": \"CLUSTER\",\n \"id\": \"2c9180866166b5b0016167c32ef31a66\",\n \"name\": \"Corporate Cluster\"\n },\n \"accountCorrelationConfig\": {\n \"type\": \"ACCOUNT_CORRELATION_CONFIG\",\n \"id\": \"2c9180855d191c59015d28583727245a\",\n \"name\": \"Directory [source-62867] Account Correlation\"\n },\n \"accountCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"2c918085708c274401708c2a8a760001\",\n \"name\": \"Example Rule\"\n },\n \"managerCorrelationMapping\": {\n \"accountAttributeName\": \"manager\",\n \"identityAttributeName\": \"manager\"\n },\n \"managerCorrelationRule\": {\n \"type\": \"RULE\",\n \"id\": \"2c918085708c274401708c2a8a760001\",\n \"name\": \"Example Rule\"\n },\n \"beforeProvisioningRule\": {\n \"type\": \"RULE\",\n \"id\": \"2c918085708c274401708c2a8a760001\",\n \"name\": \"Example Rule\"\n },\n \"schemas\": [\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"account\"\n },\n {\n \"type\": \"CONNECTOR_SCHEMA\",\n \"id\": \"2c9180835d191a86015d28455b4b232b\",\n \"name\": \"group\"\n }\n ],\n \"passwordPolicies\": [\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"2c9180855d191c59015d291ceb053980\",\n \"name\": \"Corporate Password Policy\"\n },\n {\n \"type\": \"PASSWORD_POLICY\",\n \"id\": \"2c9180855d191c59015d291ceb057777\",\n \"name\": \"Vendor Password Policy\"\n }\n ],\n \"features\": [\n \"SYNC_PROVISIONING\",\n \"MANAGER_LOOKUP\",\n \"SEARCH\",\n \"PROVISIONING\",\n \"AUTHENTICATE\",\n \"GROUP_PROVISIONING\",\n \"PASSWORD\"\n ],\n \"type\": \"OpenLDAP - Direct\",\n \"connector\": \"active-directory\",\n \"connectorClass\": \"sailpoint.connector.LDAPConnector\",\n \"connectorAttributes\": {\n \"healthCheckTimeout\": 30,\n \"authSearchAttributes\": [\n \"cn\",\n \"uid\",\n \"mail\"\n ]\n },\n \"deleteThreshold\": 10,\n \"authoritative\": false,\n \"managementWorkgroup\": {\n \"type\": \"GOVERNANCE_GROUP\",\n \"id\": \"2c91808568c529c60168cca6f90c2222\",\n \"name\": \"My Management Workgroup\"\n },\n \"healthy\": true,\n \"status\": \"SOURCE_STATE_HEALTHY\",\n \"since\": \"2021-09-28T15:48:29.3801666300Z\",\n \"connectorId\": \"active-directory\",\n \"connectorName\": \"Active Directory\",\n \"connectionType\": \"file\",\n \"connectorImplementationId\": \"delimited-file\",\n \"created\": \"2022-02-08T14:50:03.827Z\",\n \"modified\": \"2024-01-23T18:08:50.897Z\"\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> |